documentation-reviewer

To review API documentation completeness, you can audit public functions and structs for descriptions, arguments, return types, usage examples, and academic references. This ensures clarity and usability across Rust and Python codebases.

Yes, you can check for missing academic references in financial and mathematical API docs. The review process identifies incomplete documentation and suggests fixes to ensure proper academic citations are present.

The best way to improve API discoverability is by auditing public APIs to ensure all functions and structs have clear doc comments, proper argument descriptions, and illustrative examples. This enhances the overall developer experience.

You audit public API functions by reviewing them against documentation standards, checking for the presence and completeness of arguments, return types, and usage examples. It then facilitates improvement by identifying gaps.

Yes, the documentation review process works for both Rust and Python. It reviews and enhances documentation for public APIs across both codebases, ensuring quality and completeness regardless of the language.