Skip to content

Commit

Permalink
Merge pull request #19 from martinfrances107/doc_ContourBuilder
Browse files Browse the repository at this point in the history
Minor: "cargo doc" - Fixed lint issues with ContourBuilder.
  • Loading branch information
mthh authored May 10, 2024
2 parents a29d42d + a82154e commit 6b3f9a9
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
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

0 comments on commit 6b3f9a9

Please sign in to comment.