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
DOC: Improve STRtree docstrings #1626
Conversation
Test failures are unrelated, this is a doc only change |
Yes, I am trying to fix those in #1625 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nicely written, and good to distinguish between a geometry's "extent" vs "bounding box", among several other details added.
Apart from that "bounding box" is a clearer name (and I assume more people will understand it), what do you understand to be the difference between both? (my assumption was that GEOS uses "extent" term for bounding box) |
Actually, in the STRtree API, they actually use "envelope", not extent (and also the property in shapely is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the clarifications! That are nice improvements, just one nitpicky comment
I think it helps. That was my original misunderstanding. I would go further
and mention `.bounds` too.
|
Yes, but as mentioned previously it is not widely understood as bounding box. Agree there are many terms for the same thing. |
Pull Request Test Coverage Report for Build 3551050299
💛 - Coveralls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Resolves #1622
Improves STRtree docstrings in an attempt to make it more clear that the tree is based on 2-dimensional bounding boxes. Also added a note about tree efficiency, but that might be overkill for the docstring and more appropriate for dedicated documentation on STRtree - which we have not yet created.
/cc @adishavit