Doc updates #403
Merged
Doc updates #403
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
urschrei
force-pushed
the
doc_update
branch
4 times, most recently
from
4a4e697 to
af06321
Compare
frewsxcv
approved these changes
Dec 29, 2019
geo-types/src/lib.rs
Outdated
| @@ -1,3 +1,11 @@ | |||
| #![doc(html_logo_url = "https://avatars1.githubusercontent.com/u/10320338?s=1000&v=4")] | |||
There was a problem hiding this comment.
Would it also work to use this url? https://raw.githubusercontent.com/georust/meta/master/logo/logo.png This might be better since we can swap it out at any point without breaking old docs
geo-types/src/line_string.rs
Outdated
| #[derive(PartialEq, Clone, Debug, Hash)] | ||
| #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] | ||
| pub struct LineString<T>(pub Vec<Coordinate<T>>) | ||
| where | ||
| T: CoordinateType; | ||
|
|
||
| #[doc(hidden)] |
There was a problem hiding this comment.
No, just couldn't figure out a good way to explain what it was in the presence of points_iter, but got it now, I think.
| //! structs using the standard [`TryFrom`](https://doc.rust-lang.org/stable/std/convert/trait.TryFrom.html) | ||
| //! and [`TryInto`](https://doc.rust-lang.org/stable/std/convert/trait.TryInto.html) traits, | ||
| //! and conversion **from** `geo-types` primitives to `geojson` | ||
| //! `Value` structs using the [`From`](https://doc.rust-lang.org/stable/std/convert/trait.TryFrom.html) trait. |
|
Changes addressed, commit squashed! |
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Dec 29, 2019
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>
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.
(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:
LineStringdocsPointdocsclosest_pointandeuclidean_distancechamberlain_duquettedocshaversine_destinationmodule docPointsIterstruct from docs.rs