Skip to content

Commit

Permalink
add entry to doc index, add "Topology" section
Browse files Browse the repository at this point in the history
also cleanup some of my bad doc links. =(
  • Loading branch information
michaelkirk committed Mar 9, 2021
1 parent 1c1071f commit 1f91ffe
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
4 changes: 2 additions & 2 deletions geo/src/algorithm/line_intersection.rs
Expand Up @@ -27,9 +27,9 @@ impl<F: GeoFloat> LineIntersection<F> {
}
}

/// Returns the intersection between two [[`Lines`]].
/// Returns the intersection between two [`Lines`](Line).
///
/// Lines can intersect in a Point or, for Collinear lines, in a Line. See [[`LineIntersection`]]
/// Lines can intersect in a Point or, for Collinear lines, in a Line. See [`LineIntersection`]
/// for more details about the result.
///
/// # Examples
Expand Down
19 changes: 12 additions & 7 deletions geo/src/lib.rs
Expand Up @@ -63,12 +63,6 @@
//! - **[`Bearing`](algorithm::bearing::Bearing)**: Calculate the bearing between points
//! - **[`ClosestPoint`](algorithm::closest_point::ClosestPoint)**: Find the point on a geometry
//! closest to a given point
//! - **[`Contains`](algorithm::contains::Contains)**: Calculate if a geometry contains another
//! geometry
//! - **[`CoordinatePosition`](algorithm::coordinate_position::CoordinatePosition)**: Calculate
//! the position of a coordinate relative to a geometry
//! - **[`Intersects`](algorithm::intersects::Intersects)**: Calculate if a geometry intersects
//! another geometry
//! - **[`IsConvex`](algorithm::is_convex::IsConvex)**: Calculate the convexity of a
//! [`LineString`]
//! - **[`LineInterpolatePoint`](algorithm::line_interpolate_point::LineInterpolatePoint)**:
Expand All @@ -81,6 +75,18 @@
//!
//! - **[`FrechetDistance`](algorithm::frechet_distance::FrechetDistance)**: Calculate the similarity between [`LineString`]s using the Fréchet distance
//!
//! ## Topology
//!
//! - **[`Contains`](algorithm::contains::Contains)**: Calculate if a geometry contains another
//! geometry
//! - **[`CoordinatePosition`](algorithm::coordinate_position::CoordinatePosition)**: Calculate
//! the position of a coordinate relative to a geometry
//! - **[`HasDimensions`](algorithm::dimensions::HasDimensions)**: Determine the dimensions of a geometry
//! - **[`Intersects`](algorithm::intersects::Intersects)**: Calculate if a geometry intersects
//! another geometry
//! - **[`line_intersection`](algorithm::line_intersection::line_intersection)**: Calculates the
//! intersection, if any, between two lines.
//!
//! ## Winding
//!
//! - **[`Orient`](algorithm::orient::Orient)**: Apply a specified [`Winding`](algorithm::winding_order::Winding) to a [`Polygon`]’s interior and exterior rings
Expand Down Expand Up @@ -116,7 +122,6 @@
//! ## Miscellaneous
//!
//! - **[`Centroid`](algorithm::centroid::Centroid)**: Calculate the centroid of a geometry
//! - **[`HasDimensions`](algorithm::dimensions::HasDimensions)**: Determine the dimensions of a geometry
//! - **[`HaversineDestination`](algorithm::haversine_destination::HaversineDestination)**:
//! - **[`HaversineIntermediate`](algorithm::haversine_intermediate::HaversineIntermediate)**:
//! - **`Proj`**: Project geometries with the `proj` crate
Expand Down

0 comments on commit 1f91ffe

Please sign in to comment.