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

Rewrite geo crate documentation. #619

Merged
merged 4 commits into from
Feb 25, 2021
Merged

Rewrite geo crate documentation. #619

merged 4 commits into from
Feb 25, 2021

Conversation

frewsxcv
Copy link
Member

@frewsxcv frewsxcv commented Feb 4, 2021

  • I agree to follow the project's code of conduct.
  • I added an entry to CHANGES.md if knowledge of this change could be valuable to users.

Extracted out of #576

Screen Shot 2021-02-22 at 6 12 29 PM

@michaelkirk
Copy link
Member

Seems like a big improvement!

@frewsxcv frewsxcv force-pushed the frewsxcv-docs branch 2 times, most recently from d4f1dd0 to 88e3a16 Compare February 17, 2021 22:38
@frewsxcv frewsxcv marked this pull request as ready for review February 17, 2021 22:38
@frewsxcv frewsxcv force-pushed the frewsxcv-docs branch 2 times, most recently from d2b1efd to da6d302 Compare February 17, 2021 22:40
//! required to actually use the network grid.
//! - `use-serde`: enable serialisation of geometries using `serde`.
//!
//! ## GeoJSON
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we keep the GeoJSON section?

Copy link
Member

@michaelkirk michaelkirk Feb 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd wager almost everyone will want to use geo to operate on data derived outside of geo, so I think it's worth including and also simultaneously introducing the context of the geo-types crate.

Here's some off-the-cuff copy:

geojson, wkt, shapefile, and [other crates](#link to addendum with exhaustive list) which support geo-types allow you to use geo with your favorite spatial format (insert joke about shapefile).
...

Formats that support geo-types

It's a little tricky because it'd be nice to just gloss over the fact that geo-types exists for users of geo, but in reality, people using these formats may need to build the crate with --feature geo-types so it'd be good to prime them to look for the word geo-types in that crate's documentation.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd wager almost everyone will want to use geo to operate on data derived outside of geo

This was my rationale for the original inclusion of the GeoJSON section. I think it's useful to try to explicitly point out the various components of the Geo ecosystem to people as early as possible rather than relying on them to figure it out using the context from the docs.

@frewsxcv frewsxcv force-pushed the frewsxcv-docs branch 2 times, most recently from 0af9336 to fcadbd6 Compare February 22, 2021 23:12
Copy link
Member

@urschrei urschrei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just two minor things, but this is a big improvement in clarity overall. Thank you for doing this 👏👏❤️

@frewsxcv
Copy link
Member Author

@michaelkirk @urschrei How do those last few commits look? Very open to suggestions for the Ecosystem section I added

@michaelkirk
Copy link
Member

@michaelkirk @urschrei How do those last few commits look? Very open to suggestions for the Ecosystem section I added

Copy looks good! Presumably you'll need to plug in actual URL's for the ecosystem links.

Thanks for working on this!

@frewsxcv
Copy link
Member Author

Presumably you'll need to plug in actual URL's for the ecosystem links.

they're linked below. i don't see the markdown link reference feature i'm using used often and am happy to switch to inline links if people prefer that.

@michaelkirk
Copy link
Member

they're linked below. i don't see the markdown link reference feature i'm using used often and am happy to switch to inline links if people prefer that.

My bad! I thought they were just place holders. I think the link reference is great.

@urschrei
Copy link
Member

@michaelkirk @urschrei How do those last few commits look? Very open to suggestions for the Ecosystem section I added

Lgtm!

@frewsxcv
Copy link
Member Author

bors r=michaelkirk,urschrei

@bors
Copy link
Contributor

bors bot commented Feb 25, 2021

Build succeeded:

@bors bors bot merged commit 5a4c924 into master Feb 25, 2021
@urschrei urschrei deleted the frewsxcv-docs branch February 5, 2025 19:50
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

Successfully merging this pull request may close these issues.

3 participants