Add quick_collection function and revise docs. #122
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
frewsxcv
approved these changes
Feb 9, 2020
| @@ -163,6 +170,7 @@ where | |||
| ) | |||
| } | |||
|
|
|||
| #[cfg_attr(docsrs, doc(cfg(feature = "geo-types")))] | |||
There was a problem hiding this comment.
It's a docs.rs directive that calls something out as only being available if a specific feature (in this case geo-types) is enabled. I can't find the docs for it anywhere now (of course), but it's used in quite a few places.
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Feb 14, 2020
122: Add quick_collection function and revise docs. r=urschrei a=urschrei The `quick_collection` function is essentially a port of the functionality provided by @lelongg's https://github.com/lelongg/geo-geojson crate: it accepts an arbitrary `geojson::GeoJson` object, and produces a `geo::GeometryCollection` for users who just want to process their geometries using `geo`'s functionality (I suspect this is the primary use case for a lot of users). The docs have been revised to add more detail about the structure of the crate, how to get started etc, and details about what `quick_collection` does and how it works. They now explicitly point out that you **must** enable the `geo-types` feature in order to use the conversion traits and `quick_collection` – I'm on the fence as to whether this should all just be enabled by default. As I point out, `quick_collection` potentially sacrifices a little performance due to the use of `clone()` and creating new `Vec`s. I don't think we can do much about the latter, but if anyone wants to have a look at the clone() stuff feel free. Co-authored-by: Stephan Hügel <shugel@tcd.ie> Co-authored-by: Stephan Hügel <urschrei@gmail.com>
Build succeeded |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
quick_collectionfunction is essentially a port of the functionality provided by @lelongg's https://github.com/lelongg/geo-geojson crate: it accepts an arbitrarygeojson::GeoJsonobject, and produces ageo::GeometryCollectionfor users who just want to process their geometries usinggeo's functionality (I suspect this is the primary use case for a lot of users).The docs have been revised to add more detail about the structure of the crate, how to get started etc, and details about what
quick_collectiondoes and how it works. They now explicitly point out that you must enable thegeo-typesfeature in order to use the conversion traits andquick_collection– I'm on the fence as to whether this should all just be enabled by default.As I point out,
quick_collectionpotentially sacrifices a little performance due to the use ofclone()and creating newVecs. I don't think we can do much about the latter, but if anyone wants to have a look at the clone() stuff feel free.