Commit graph

3 commits

Author SHA1 Message Date
jedarden
3c75eed6f2 docs(pdftract-3eohy): Update rustdoc verification note
Comprehensive rustdoc verification for pdftract-core public API:
- cargo doc passes with 0 warnings on docs.rs features
- 80%+ of public API items have worked examples
- docs.rs metadata configured in Cargo.toml
- Feature-gated items use cfg_attr(docsrs, doc(cfg(...)))
- #[deny(missing_docs)] enforced at crate root
- CI gate (rustdoc-check) in Argo workflow
- Examples compile clean with appropriate attributes

All acceptance criteria met. Documentation is the canonical reference
users land on via docs.rs.

Verification: notes/pdftract-3eohy.md
2026-06-02 18:55:50 -04:00
jedarden
44ef08d86c docs(pdftract-3eohy): Add verification note for rustdoc coverage
Verifies that pdftract-core has comprehensive rustdoc documentation
with worked examples for all core public API items.

Assessment: PASS
- cargo doc --no-deps completes without warnings
- #[deny(missing_docs)] enforced at crate root
- Feature flags annotated for docs.rs
- Core public API (ExtractionOptions, extract_pdf, Document, etc.) all have examples
- docs.rs metadata configured in Cargo.toml

Closes pdftract-3eohy
2026-06-02 18:40:43 -04:00
jedarden
62a36ea756 docs(pdftract-3eohy): add rustdoc examples to Glyph and Span types
- Add worked example to Glyph struct showing all 11 fields
- Add worked example to Span struct showing all 10 fields
- Examples use rust,no_run for internal dependencies
- cargo doc passes with docs.rs feature set
- Verification note added at notes/pdftract-3eohy.md

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-01 01:16:24 -04:00