From b09380e3ffd963441c2dc3d5e8c75b8cf340bb0e Mon Sep 17 00:00:00 2001 From: Bruce Mitchener Date: Sun, 25 Mar 2018 22:01:59 +0700 Subject: [PATCH 1/5] Capitalize 'Cartesian'. --- src/homogen.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/homogen.rs b/src/homogen.rs index 2bf9baa..c48f00d 100644 --- a/src/homogen.rs +++ b/src/homogen.rs @@ -38,7 +38,7 @@ impl HomogeneousVector { impl, U> HomogeneousVector { - /// Convert into cartesian 2D point. + /// Convert into Cartesian 2D point. /// /// Note: possible division by zero. #[inline] @@ -46,7 +46,7 @@ impl, U> HomogeneousVector { TypedPoint2D::new(self.x / self.w, self.y / self.w) } - /// Convert into cartesian 3D point. + /// Convert into Cartesian 3D point. /// /// Note: possible division by zero. #[inline] From 2b53f44165284e9d7c1f8ccfb709db38aa66dd8c Mon Sep 17 00:00:00 2001 From: Bruce Mitchener Date: Sun, 25 Mar 2018 22:02:32 +0700 Subject: [PATCH 2/5] Link to TypedScale docs rather than just point there. --- src/length.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/length.rs b/src/length.rs index 08604e5..8a7caff 100644 --- a/src/length.rs +++ b/src/length.rs @@ -31,7 +31,9 @@ use std::fmt; /// enum. /// /// You can multiply a `Length` by a `scale::TypedScale` to convert it from one unit to -/// another. See the `TypedScale` docs for an example. +/// another. See the [`TypedScale`] docs for an example. +/// +/// [`TypedScale`]: struct.TypedScale.html #[repr(C)] pub struct Length(pub T, PhantomData); From 214b0248410b6551c4f88e90c91530473dee8945 Mon Sep 17 00:00:00 2001 From: Bruce Mitchener Date: Sun, 25 Mar 2018 22:02:53 +0700 Subject: [PATCH 3/5] Fix some typos. --- src/point.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/point.rs b/src/point.rs index 17914ce..a6a6cde 100644 --- a/src/point.rs +++ b/src/point.rs @@ -406,7 +406,7 @@ define_matrix! { pub type Point3D = TypedPoint3D; impl TypedPoint3D { - /// Constructor, setting all copmonents to zero. + /// Constructor, setting all components to zero. #[inline] pub fn origin() -> Self { point3(Zero::zero(), Zero::zero(), Zero::zero()) @@ -470,7 +470,7 @@ impl TypedPoint3D { /// Cast this point into a vector. /// - /// Equivalent to substracting the origin to this point. + /// Equivalent to subtracting the origin to this point. #[inline] pub fn to_vector(&self) -> TypedVector3D { vec3(self.x, self.y, self.z) From ea530b2fcc9f64d4798a89d1eb236e7060e68559 Mon Sep 17 00:00:00 2001 From: Bruce Mitchener Date: Sun, 25 Mar 2018 22:03:37 +0700 Subject: [PATCH 4/5] Transform3D is a 3D, not 4D transform. --- src/transform3d.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/transform3d.rs b/src/transform3d.rs index 6ab9d59..18b0a73 100644 --- a/src/transform3d.rs +++ b/src/transform3d.rs @@ -42,7 +42,7 @@ define_matrix! { } } -/// The default 4d transform type with no units. +/// The default 3d transform type with no units. pub type Transform3D = TypedTransform3D; impl TypedTransform3D { From 52ccbb2e1a645ef368590b421430290a45e83e37 Mon Sep 17 00:00:00 2001 From: Bruce Mitchener Date: Sun, 25 Mar 2018 22:04:07 +0700 Subject: [PATCH 5/5] Missing backticks in docs. --- src/transform3d.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/transform3d.rs b/src/transform3d.rs index 18b0a73..d72bd81 100644 --- a/src/transform3d.rs +++ b/src/transform3d.rs @@ -153,7 +153,7 @@ where T: Copy + Clone + ) } - /// Returns true if this transform can be represented with a TypedTransform2D. + /// Returns true if this transform can be represented with a `TypedTransform2D`. /// /// See #[inline] @@ -394,7 +394,7 @@ where T: Copy + Clone + ) } - /// Convenience function to create a scale transform from a TypedScale. + /// Convenience function to create a scale transform from a `TypedScale`. pub fn from_scale(scale: TypedScale) -> Self { TypedTransform3D::create_scale(scale.get(), scale.get(), scale.get()) }