georust / geo

Geospatial primitives and algorithms for Rust
https://crates.io/crates/geo
Other
1.49k stars 194 forks source link

Improve Documentation for HaversineIntermediate #1060

Open JosiahParry opened 11 months ago

JosiahParry commented 11 months ago

Documentation for HaversineIntermediate trait can be improved.

Notably the parts that can be improved are the function arguments f for haversine_intermediate() and max_dist and include_ends for haversine_intermediate_fill().

If some clarity can be provided in this issue I'd be happy to make a PR

https://github.com/georust/geo/blob/d13e70c6438d4b8a845a1403afb8db4ec146f251/geo/src/algorithm/haversine_intermediate.rs#L6

JayKickliter commented 10 months ago

I was just about to open this same exact issue for GeodesicIntermediate.

JayKickliter commented 10 months ago

I'd be happy to open a PR if someone more familiar with domain can confirm @JosiahParry's deductions.

michaelkirk commented 10 months ago

I don't use either of those traits, but taking a quick look at the code, your interpretation seems correct to me @JosiahParry.

Looking at the git archeology, it seems probable that the docs/names for the GeodesicIntermediate were copy/pasted from HaversineIntermediate.

If either of you want to open PRs with better docs, that'd be excellent.