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 Documentation for HaversineIntermediate #1060

Open
JosiahParry opened this issue Aug 27, 2023 · 3 comments
Open

Improve Documentation for HaversineIntermediate #1060

JosiahParry opened this issue Aug 27, 2023 · 3 comments

Comments

@JosiahParry
Copy link
Contributor

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().

  • I think the f is short for fraction of the distance between self and other.
  • I think haversine_intermediate_fill() returns a vector of the points that are interpolated between self and other

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

pub trait HaversineIntermediate<T: CoordFloat> {

@JayKickliter
Copy link

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

@JayKickliter
Copy link

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

@michaelkirk
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants