Enable, revise, and expand GeoJSON --> Geo conversion docs

georust · Dec 21, 2017 · a3fad98 · a3fad98
1 parent b51f993
commit a3fad98
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/src/conversion.rs b/src/conversion.rs
@@ -122,6 +122,7 @@ fn create_geo_multi_polygon<T>(multi_polygon_type: &Vec<PolygonType>) -> geo::Mu
         .collect())
 }
 
+/// This trait provides fallible conversions from GeoJSON values to [Geo](https://docs.rs/geo) types
 pub trait TryInto<T> {
     type Err;
     fn try_into(self) -> Result<T, Self::Err>;

diff --git a/src/lib.rs b/src/lib.rs
@@ -181,6 +181,15 @@
 //!     process_geojson(&geojson);
 //! }
 //! ```
+//!
+//! ## 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
+//! to [Geo](https://docs.rs/geo) types, allowing them to be measured or used in calculations. Note that
+//! this conversion consumes the GeoJSON object, so you will not be able to match
+//! by reference as in the example above. The [polylabel_cmd](https://github.com/urschrei/polylabel_cmd/blob/master/src/main.rs) crate contains an
+//! implementation which may be useful if you wish to perfom these conversions.
+
 
 extern crate serde;
 #[macro_use]
@@ -222,8 +231,7 @@ pub use feature::Feature;
 mod feature_collection;
 pub use feature_collection::FeatureCollection;
 
-/// Convert geo::types to geometry::Geometry
-#[doc(hidden)]
+/// Convert Geometries into [Geo](https://docs.rs/geo) types
 pub mod conversion;
 
 /// Error when reading a GeoJSON object from a str or Object