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.

Sign up for GitHub

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

Jump to bottom

add doc comments for functions #11

Open
stonylohr opened this issue Jul 17, 2020 · 1 comment
Open

add doc comments for functions #11

stonylohr opened this issue Jul 17, 2020 · 1 comment

Comments

@stonylohr
Copy link
Contributor

Many functions have stub doc comments (///), but more detail would be preferable. The C++ code typically includes expansive comments and could be a good source to start from.

I have not yet explored annotation syntax for rust doc comments, so I'm unsure how much conversion would be needed when copying doc comments from c++ or other geographic lib counterparts.
@michaelkirk
Copy link
Member

This would be excellent!

@stonylohr stonylohr mentioned this issue Jan 23, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@michaelkirk @stonylohr