georust / geographiclib-rs

A port of geographiclib in Rust.
MIT License
41 stars 9 forks source link

add doc comments for functions #11

Open stonylohr opened 4 years ago

stonylohr commented 4 years ago

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 commented 4 years ago

This would be excellent!