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.

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

Minor: "cargo doc" - Fixed lint issues with ContourBuilder. #19

Merged
merged 1 commit into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/band.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use crate::Float;
use geo_types::MultiPolygon;

/// An isoband has the geometry and min / max values of a contour ring, built by [`ContourBuilder`].
/// An isoband has the geometry and min / max values of a contour ring, built by [ContourBuilder](`crate::contourbuilder::ContourBuilder`).
#[derive(Debug, Clone)]
pub struct Band {
pub(crate) geometry: MultiPolygon<Float>,
Expand Down
2 changes: 1 addition & 1 deletion src/contour.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use crate::Float;
use geo_types::MultiPolygon;

/// A contour has the geometry and threshold of a contour ring, built by [`ContourBuilder`].
/// A contour has the geometry and threshold of a contour ring, built by [ContourBuilder](`crate::contourbuilder::ContourBuilder`).
#[derive(Debug, Clone)]
pub struct Contour {
pub(crate) geometry: MultiPolygon<Float>,
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
//! [marching squares](https://en.wikipedia.org/wiki/Marching_squares)
//! to a rectangular array of numeric values.
//!
//! Use the [`ContourBuilder`]) to compute for a given set of values and thresholds:
//! Use the [`ContourBuilder`] to compute for a given set of values and thresholds:
//! - isolines, as a Vec of [`Line`],
//! - contour polygons, as a Vec of [`Contour`],
//! - isobands, as a Vec of [`Band`].
Expand Down
2 changes: 1 addition & 1 deletion src/line.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use crate::Float;
use geo_types::MultiLineString;

/// A line has the geometry and threshold of a contour ring, built by [`ContourBuilder`].
/// A line has the geometry and threshold of a contour ring, built by [ContourBuilder](`crate::contourbuilder::ContourBuilder`).
#[derive(Debug, Clone)]
pub struct Line {
pub(crate) geometry: MultiLineString<Float>,
Expand Down
Loading