georust / geo / 1814

86%

push

travis-ci

Merge #403

403: Doc updates r=urschrei a=urschrei

(To be merged after #402)

This PR adds top-level docs (mostly the same as what's currently in the README), and the following changes:

- Revised `LineString` docs
- Revised `Point` docs
- Revised module docs to better distinguish `closest_point` and `euclidean_distance`
- Revised `chamberlain_duquette` docs
- Revised `haversine_destination` module doc
- Note existence of some non-euclidean distance algorithms
- Detail optional features
- Make GeoJSON interop more obvious. This is somewhat redundant, since the GeoJSON crate says the same thing, but we don't know what crate people will see first, so I think it's OK
- Hidden the `PointsIter` struct from docs.rs

Co-authored-by: Stephan Hügel <shugel@tcd.ie>

2 of 2 new or added lines in 1 file covered. (100.0%)

14193 of 15894 relevant lines covered (89.3%)

5.1 hits per line