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

LineString contains contradictory information in docs #1256

Open
frewsxcv opened this issue Nov 4, 2024 · 1 comment · May be fixed by #1262
Open

LineString contains contradictory information in docs #1256

frewsxcv opened this issue Nov 4, 2024 · 1 comment · May be fixed by #1262
Labels
geo

Comments

@frewsxcv
Copy link
Member

frewsxcv commented Nov 4, 2024

https://docs.rs/geo-types/latest/geo_types/geometry/struct.LineString.html

The first line says:

An ordered collection of two or more Coords, representing a path between locations.

Whereas the following line says:

A LineString is closed if it is empty, or if the first and last coordinates are the same.

So is it "two or more" or can it be "empty"?
@frewsxcv frewsxcv added the geo label Nov 4, 2024
@frewsxcv
Copy link
Member Author

frewsxcv commented Nov 4, 2024

Oh well later it says:

A LineString is valid if it is either empty or contains 2 or more coordinates.

So maybe it's just the first line of the docs that could be tweaked that could indicate it could also be empty 🤷🏻 Or maybe it's not worth changing

@michaelkirk michaelkirk linked a pull request Nov 5, 2024 that will close this issue
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
geo
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update line_string.rs georust/geo
1 participant
@frewsxcv