Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixup cargo-doc warnings #855

Merged
merged 2 commits into from
Jun 24, 2022
Merged

Fixup cargo-doc warnings #855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcb6be2
Fixup cargo-doc warnings
michaelkirk Jun 24, 2022
05c64dc
update CHANGES.md
michaelkirk Jun 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions geo/CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@
you some typing if you're using f64. The same change applies to `Coordinates`
and all the geometry variants, like `Point`, `LineString`, etc.
* <https://github.com/georust/geo/pull/832>
* `Winding` trait is rexported under geo::algorithm::Winding (and thus
geo::Winding and geo::prelude::Winding)
* <https://github.com/georust/geo/pull/855/files>
* BREAKING: de-exported `WindingOrder` from `geo::WindingOrder`/`geo::algorithms::WindingOrder`.
Instead, go back to `use geo::winding_order::WindingOrder` - it was briefly rexported as
`geo::WindingOrder` and `geo::algorithms::WindingOrder`.
* <https://github.com/georust/geo/pull/855/files>

## 0.21.0

Expand Down
3 changes: 2 additions & 1 deletion geo/src/algorithm/bool_ops/op.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ use std::{cell::Cell, cmp::Ordering, fmt::Debug};
use super::*;
use crate::{
sweep::{Cross, Crossing, CrossingsIter, LineOrPoint},
CoordsIter, GeoFloat as Float, LineString, Polygon, WindingOrder,
winding_order::WindingOrder,
CoordsIter, GeoFloat as Float, LineString, Polygon,
};

#[derive(Debug, Clone)]
Expand Down
2 changes: 1 addition & 1 deletion geo/src/algorithm/map_coords.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ mod modern {
/// ```
///
/// If you want *only* to convert between numeric types (i32 -> f64) without further
/// transformation, consider using [`Convert].
/// transformation, consider using [`Convert`](crate::Convert).
fn map_coords(&self, func: impl Fn(Coordinate<T>) -> Coordinate<NT> + Copy) -> Self::Output
where
T: CoordNum,
Expand Down
2 changes: 1 addition & 1 deletion geo/src/algorithm/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ pub use vincenty_length::VincentyLength;

/// Calculate and work with the winding order of `Linestring`s.
pub mod winding_order;
pub use winding_order::WindingOrder;
pub use winding_order::Winding;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got confused when I re-exported winding_order::WindingOrder from the algorithm module.

Breaking with the convention of our other modules, winding_order::Winding is the trait, while winding_order::WindingOrder is the type returned by that traits methods.


/// Planar sweep algorithm and related utils
pub mod sweep;
Expand Down
2 changes: 1 addition & 1 deletion geo/src/algorithm/sweep/iter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ where
/// ## Usage
///
/// Construct from an iterator of any type implementing the
/// [`Cross`] trait. The geo-type [`Line`] implements this trait.
/// [`Cross`] trait. The geo-type [`Line`](crate::Line) implements this trait.
/// See the trait documentation for more information on usage with
/// custom types.
///
Expand Down
4 changes: 2 additions & 2 deletions geo/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@
//!
//! ## Winding
//!
//! - **[`Orient`](Orient)**: Apply a specified [`Winding`](Winding) to a [`Polygon`]’s interior and exterior rings
//! - **[`Winding`](Winding)**: Calculate and manipulate the winding order of a [`LineString`]
//! - **[`Orient`](Orient)**: Apply a specified winding [`Direction`](orient::Direction) to a [`Polygon`]’s interior and exterior rings
//! - **[`Winding`](Winding)**: Calculate and manipulate the [`WindingOrder`](winding_order::WindingOrder) of a [`LineString`]
//!
//! ## Iteration
//!
Expand Down