From e55c72fddcb900fec3d822a4dfed90327380bd27 Mon Sep 17 00:00:00 2001 From: Jack Wrenn Date: Mon, 10 Dec 2018 16:19:59 -0500 Subject: [PATCH] Deprecate `norm`. See #371. --- src/lib.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index ce99949d..adcdaa66 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -452,6 +452,14 @@ pub fn angle(a: &V, b: &V) -> V::Real { /// * [`magnitude`](fn.magnitude.html) /// * [`magnitude_squared`](fn.magnitude_squared.html) /// * [`norm_squared`](fn.norm_squared.html) +/// +/// # Deprecated +/// Use these methods instead: +/// - [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")] #[inline] pub fn norm(v: &V) -> V::Field { v.norm()