clean up docs (#91)

chungg · Aug 26, 2024 · c4423f5 · c4423f5
1 parent eee0e9c
commit c4423f5
Show file tree

Hide file tree

Showing 8 changed files with 247 additions and 247 deletions.
diff --git a/src/correlation.rs b/src/correlation.rs
@@ -35,8 +35,8 @@ use crate::statistic::distribution::{cov_stdev, rank, RankMode};
 /// use traquer::correlation;
 ///
 /// correlation::pcc(
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
 ///     6).collect::<Vec<f64>>();
 ///
 /// ```
@@ -91,8 +91,8 @@ pub fn pcc<'a, T: ToPrimitive>(
 /// use traquer::correlation;
 ///
 /// correlation::rsq(
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
 ///     6).collect::<Vec<f64>>();
 ///
 /// ```
@@ -124,8 +124,8 @@ pub fn rsq<'a, T: ToPrimitive>(
 /// use traquer::correlation;
 ///
 /// correlation::beta(
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
 ///     2).collect::<Vec<f64>>();
 ///
 /// ```
@@ -189,8 +189,8 @@ pub fn beta<'a, T: ToPrimitive>(
 /// use traquer::correlation;
 ///
 /// correlation::perf(
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
 ///     2).collect::<Vec<f64>>();
 ///
 /// ```
@@ -227,8 +227,8 @@ pub fn perf<'a, T: ToPrimitive>(
 /// use traquer::correlation;
 ///
 /// correlation::rsc(
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
 ///     ).collect::<Vec<f64>>();
 ///
 /// ```
@@ -262,8 +262,8 @@ pub fn rsc<'a, T: ToPrimitive>(
 /// use traquer::correlation;
 ///
 /// correlation::srcc(
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
 ///     6).collect::<Vec<f64>>();
 ///
 /// ```
@@ -308,8 +308,8 @@ pub fn srcc<'a, T: ToPrimitive + PartialOrd + Clone>(
 /// use traquer::correlation;
 ///
 /// correlation::krcc(
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
 ///     6).collect::<Vec<f64>>();
 ///
 /// ```
@@ -370,8 +370,8 @@ pub fn krcc<'a, T: ToPrimitive>(
 /// use traquer::correlation;
 ///
 /// correlation::hoeffd(
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
-///     &vec![1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
+///     &[1.0,2.0,3.0,4.0,5.0,6.0,4.0,5.0],
 ///     6).collect::<Vec<f64>>();
 ///
 /// ```