Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve sophus-rs library API docs - make it self contained #62

Open
strasdat opened this issue Feb 2, 2025 · 0 comments
Open

improve sophus-rs library API docs - make it self contained #62

strasdat opened this issue Feb 2, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@strasdat
Copy link
Contributor

strasdat commented Feb 2, 2025

Improve documentation on docs.rs. In particular, extend if from single sentence per public function / struct to a more complete paragraphs. The documentation shall be coherent without looking at the source code. Take the rust standard library documentation as an example: https://doc.rust-lang.org/std/index.html.

@strasdat strasdat added the documentation Improvements or additions to documentation label Feb 2, 2025
@strasdat strasdat changed the title improve sophus-rs library documentation - make it self contained improve sophus-rs library API docs - make it self contained Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant