Merge pull request #6 from raidwas/patch-1

update docs
frewsxcv · Jan 31, 2020 · ace6108 · ace6108
2 parents 3b14352 + 75d2c49
commit ace6108
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/lib.rs b/src/lib.rs
@@ -2,7 +2,9 @@
 
 pub trait Gcd {
     /// Determine [greatest common divisor](https://en.wikipedia.org/wiki/Greatest_common_divisor)
-    /// using the [Euclidean algorithm](https://en.wikipedia.org/wiki/Euclidean_algorithm)
+    /// using [`gcd_binary`].
+    ///
+    /// [`gcd_binary`]: #method.gcd_binary
     ///
     /// # Examples
     ///
@@ -16,7 +18,11 @@ pub trait Gcd {
     /// assert_eq!(44, 2024u32.gcd(748));
     /// ```
     fn gcd(self, other: Self) -> Self;
+    /// Determine [greatest common divisor](https://en.wikipedia.org/wiki/Greatest_common_divisor)
+    /// using the [Binary GCD algorithm](https://en.wikipedia.org/wiki/Binary_GCD_algorithm).
     fn gcd_binary(self, other: Self) -> Self;
+    /// Determine [greatest common divisor](https://en.wikipedia.org/wiki/Greatest_common_divisor)
+    /// using the [Euclidean algorithm](https://en.wikipedia.org/wiki/Euclidean_algorithm).
     fn gcd_euclid(self, other: Self) -> Self;
 }