-
Notifications
You must be signed in to change notification settings - Fork 60
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
Revamp docs #183
Revamp docs #183
Conversation
//! # #[cfg(feature = "geo-types")] | ||
//! let polys = vec![poly]; | ||
//! # #[cfg(feature = "geo-types")] | ||
//! let gc = GeometryCollection::from_iter(polys); |
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.
ack, I lost this example. I'm going to re-add it. One minute!
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.
Ok, restored!
I did move it to the ### From geo-types to geojson
section below. It seemed a little out of place as the very first example in the doc.
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.
Just some very minor suggestions, so take or leave them as you see fit. The only other issue relates to quick_collection
which IIRC can be a bit less efficient than manually processing geometries – not sure whether we want to call that out.
In any case, this is a vast improvement in clarity. Thank you!
Some of it I hope is uncontroversial: - there were references to old serialization engines. - linkified more entities Some of it is potentially more controversial - and I'm open to changing it based on feedback: Primarily, I attempted to make the docs more perusable for people that like to gloss over and find examples, while maintaining a decent amount of coherent narrative for the blessed people that actually read docs top to bottom.
Thank you very much for the close proofread! I incorporated all of your suggestions and squashed. bors r=lnicola,urschrei |
Build succeeded: |
CHANGES.md
if knowledge of this change could be valuable to users.Some of it I hope is uncontroversial:
Some of it is potentially more controversial - and I'm open to changing
it based on feedback:
Primarily, I attempted to make the docs more perusable for people that
like to gloss over and find examples, while maintaining a decent amount
of coherent narrative for the blessed people that actually read docs top
to bottom.