Update doc comment

This commit is contained in:
Hanno Braun 2023-08-11 13:02:50 +02:00
parent 5fb76e8a02
commit 3fee65dbd2

View File

@ -40,10 +40,8 @@ impl<T: CurveBoundaryElement> CurveBoundary<T> {
/// Normalize the boundary /// Normalize the boundary
/// ///
/// Returns a new instance of this struct, which has the bounding elements /// Returns a new instance of this struct, which has the bounding elements
/// in a defined order, alongside a boolean that indicates whether the new /// in a defined order. This can be used to compare boundaries while
/// instance is different from the original one. /// disregarding their direction.
///
/// This can be used to compare a boundary while disregarding its direction.
#[must_use] #[must_use]
pub fn normalize(self) -> Self { pub fn normalize(self) -> Self {
if self.is_normalized() { if self.is_normalized() {