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

Expand docs with parsing examples and corner cases, and enable conversion docs #85

Merged
merged 6 commits into from
Dec 26, 2017

Conversation

urschrei
Copy link
Member

@urschrei urschrei commented Dec 21, 2017

This also inserts a blank properties map when serialising, if the field was set to None. See b51f993

A GeoJSON Feature object MUST include a properties field. Currently,
if it's set to None when initialising a Feature struct, the field
won't be serialised, resulting in invalid GeoJSON.
Copy link
Member

@frewsxcv frewsxcv left a comment

Choose a reason for hiding this comment

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

this looks great! this should make it easier for users who are just interested in parsing geojson 👌

just one comment about a url in the docs, but looks good to me!

src/lib.rs Outdated
//!
//! ## Conversion to Geo objects
//!
//! The [try_into](file:///Users/sth/dev/rust-geojson/target/doc/geojson/conversion/index.html) trait provides *fallible* conversions from GeoJSON Value structs
Copy link
Member

Choose a reason for hiding this comment

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

[try_into](file:///Users/sth/dev/rust-geojson/target/doc/geojson/conversion/index.html)

this should probably be a relative URL path to index.html

@urschrei
Copy link
Member Author

bors r+

bors bot added a commit that referenced this pull request Dec 26, 2017
85: Expand docs with parsing examples and corner cases, and enable conversion docs r=urschrei a=urschrei

This also inserts a blank `properties` map when serialising, if the field was set to `None`. See b51f993
@bors
Copy link
Contributor

bors bot commented Dec 26, 2017

Build succeeded

@bors bors bot merged commit daf44ee into georust:master Dec 26, 2017
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.

2 participants