From 2bb7c011b1ff9c75a14b603ed2b9a2c3ab280b6b Mon Sep 17 00:00:00 2001 From: Jack Wrenn Date: Mon, 10 Dec 2018 16:24:08 -0500 Subject: [PATCH] Deprecate `norm_squared` See #371. --- src/lib.rs | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index adcdaa66..7a11965b 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -455,8 +455,8 @@ pub fn angle(a: &V, b: &V) -> V::Real { /// /// # Deprecated /// Use these methods instead: -/// - [Matrix::norm] -/// - [Quaternion::norm] +/// * [Matrix::norm] +/// * [Quaternion::norm] /// /// Or, use [NormedSpace::norm](https://docs.rs/alga/0.7.2/alga/linear/trait.NormedSpace.html#tymethod.norm). #[deprecated(note = "use `Matrix::norm` or `Quaternion::norm` instead")] @@ -472,6 +472,14 @@ pub fn norm(v: &V) -> V::Field { /// * [`magnitude`](fn.magnitude.html) /// * [`magnitude_squared`](fn.magnitude_squared.html) /// * [`norm`](fn.norm.html) +/// +/// # Deprecated +/// Use these methods instead: +/// * [Matrix::norm_squared] +/// * [Quaternion::norm_squared] +/// +/// Or, use [NormedSpace::norm_squared](https://docs.rs/alga/0.7.2/alga/linear/trait.NormedSpace.html#tymethod.norm_squared). +#[deprecated(note = "use `Matrix::norm_squared` or `Quaternion::norm_squared` instead")] #[inline] pub fn norm_squared(v: &V) -> V::Field { v.norm_squared()