search

georust / geojson

Library for serializing the GeoJSON vector GIS file format
https://crates.io/crates/geojson
Apache License 2.0
276 stars 60 forks source link

deprecate quick_collection, simplify docs #214

Closed michaelkirk closed 4 months ago

michaelkirk commented 1 year ago

The real motivation for this pull request, is that I was trying to look up some basic usage of the geojson crate and it took me uncomfortably long. Our documentation has grown over time and become a bit long winded in my experience.

So I was looking for ways to simplify our documentation, and noticed the couple paragraphs devoted to quick_collection. Since quick_collection converts &GeoJson -> Result<geo_types::GeometryCollection>, I think it will be more discoverable under the idiomatic TryFrom trait, and because it's working like the idiomatic TryFrom trait, I think we can truncate some of the documentation.

lnicola commented 1 year ago

bors d+

(needs rebase)

bors[bot] commented 1 year ago

:v: michaelkirk can now approve this pull request. To approve and merge a pull request, simply reply with bors r+. More detailed instructions are available here.

michaelkirk commented 4 months ago

Sorry that I didn't merge this a long time ago!

I've made a couple minor changes but the thrust is the same. Can I get another review?