Review recipes, updates to language and style

Author: AndyGauge

Cargo.toml

@@ -54,6 +54,8 @@ syslog = "4.0"
 
 [build-dependencies]
 skeptic = "0.13"
+walkdir = "2.0"
 
 [dev-dependencies]
 skeptic = "0.13"
+walkdir = "2.0"

build.rs

@@ -1,9 +1,10 @@
 extern crate skeptic;
+extern crate walkdir;
 
-use std::fs;
+use walkdir::WalkDir;
 
 fn main() {
-    let paths = fs::read_dir("./src/").unwrap()
+    let paths = WalkDir::new("./src/").into_iter()
         // convert paths to Strings
         .map(|p| p.unwrap().path().to_str().unwrap().to_string())
         // only compile markdown files

src/algorithms/randomness/rand-choose.md

@@ -23,4 +23,4 @@ fn main() {
 }
 ```
 
-[`choose`]: https://docs.rs/rand/0.4/rand/trait.Rng.html#method.choose
+[`choose`]: https://docs.rs/rand/*/rand/trait.Rng.html#method.choose

src/algorithms/randomness/rand-custom.md

@@ -3,21 +3,22 @@
 [![rand-badge]][rand] [![cat-science-badge]][cat-science]
 
 Randomly generates a tuple `(i32, bool, f64)` and variable of user defined type `Point`.
-Implements the [`rand::Rand`] trait for `Point` in order to allow random generation.
+Implements the [`Distribution`] trait on type Point for [`Standard`] in order to allow random generation.
 
 ```rust
 extern crate rand;
 
-use rand::{Rng, Rand};
+use rand::Rng;
+use rand::distributions::{Distribution, Standard};
 
 #[derive(Debug)]
 struct Point {
     x: i32,
     y: i32,
 }
 
-impl Rand for Point {
-    fn rand<R: Rng>(rng: &mut R) -> Point {
+impl Distribution<Point> for Standard {
+    fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Point {
         let (rand_x, rand_y) = rng.gen();
         Point {
             x: rand_x,
@@ -35,4 +36,5 @@ fn main() {
 }
 ```
 
-[`rand::Rand`]: https://doc.rust-lang.org/rand/0.4/rand/trait.Rand.html
+[`Distribution`]: https://docs.rs/rand/*/rand/distributions/trait.Distribution.html
+[`Standard`]: https://docs.rs/rand/*/rand/distributions/struct.Standard.html

src/algorithms/randomness/rand-dist.md

@@ -14,20 +14,19 @@ The [distributions available are documented here][rand-distributions]. An exampl
 ```rust
 extern crate rand;
 
-use rand::distributions::{Normal, IndependentSample};
+use rand::distributions::{Normal, Distribution};
 
 fn main() {
   let mut rng = rand::thread_rng();
-
-  // mean 2, standard deviation 3:
   let normal = Normal::new(2.0, 3.0);
-  let v = normal.ind_sample(&mut rng);
+  let v = normal.sample(&mut rng);
   println!("{} is from a N(2, 9) distribution", v)
 }
 ```
 
-[`IndependentSample::ind_sample`]: https://doc.rust-lang.org/rand/0.4/rand/distributions/trait.IndependentSample.html#tymethod.ind_sample
-[`Normal`]: https://doc.rust-lang.org/rand/0.4/rand/distributions/normal/struct.Normal.html
-[`rand::Rng`]: https://doc.rust-lang.org/rand/0.4/rand/trait.Rng.html
-[rand-distributions]: https://doc.rust-lang.org/rand/0.4/rand/distributions/index.html
+[`Distribution::sample`]: https://docs.rs/rand/*/rand/distributions/trait.Distribution.html#tymethod.sample
+[`Normal`]: https://docs.rs/rand/*/rand/distributions/normal/struct.Normal.html
+[`rand::Rng`]: https://docs.rs/rand/*/rand/trait.Rng.html
+[rand-distributions]: https://docs.rs/rand/*/rand/distributions/index.html
+
 [uniform distribution]: https://en.wikipedia.org/wiki/Uniform_distribution_(continuous)

src/algorithms/randomness/rand-passwd.md

@@ -2,17 +2,23 @@
 
 [![rand-badge]][rand] [![cat-os-badge]][cat-os]
 
-Randomly generates a string of given length ASCII characters in the range `A-Z, a-z, 0-9`, with [`gen_ascii_chars`].
+Randomly generates a string of given length ASCII characters in the range `A-Z,
+a-z, 0-9`, with [`Alphanumeric`] sample.
 
 ```rust
 extern crate rand;
 
 use rand::{thread_rng, Rng};
+use rand::distributions::Alphanumeric;
 
 fn main() {
-    let rand_string: String = thread_rng().gen_ascii_chars().take(30).collect();
+    let rand_string: String = thread_rng()
+        .sample_iter(&Alphanumeric)
+        .take(30)
+        .collect();
+
     println!("{}", rand_string);
 }
 ```
 
-[`gen_ascii_chars`]: https://docs.rs/rand/0.4/rand/trait.Rng.html#method.gen_ascii_chars
+[`Alphanumeric`]: https://docs.rs/rand/*/rand/distributions/struct.Alphanumeric.html#struct.Alphanumaric

src/algorithms/randomness/rand-range.md

@@ -1,5 +1,3 @@
-[ex-rand-range]: #ex-rand-range
-<a name="ex-rand-range"></a>
 ## Generate random numbers within a range
 
 [![rand-badge]][rand] [![cat-science-badge]][cat-science]
@@ -25,14 +23,14 @@ in the same range.
 ```rust
 extern crate rand;
 
-use rand::distributions::{Range, IndependentSample};
+use rand::distributions::{Range, Distribution};
 
 fn main() {
     let mut rng = rand::thread_rng();
     let die = Range::new(1, 7);
 
     loop {
-        let throw = die.ind_sample(&mut rng);
+        let throw = die.sample(&mut rng);
         println!("Roll the die: {}", throw);
         if throw == 6 {
             break;

src/algorithms/randomness/rand.md

@@ -3,29 +3,28 @@
 [![rand-badge]][rand] [![cat-science-badge]][cat-science]
 
 Generates random numbers with help of random-number
-generator [`rand::Rng`] obtained via [`rand::thread_rng`].
+generator [`rand::Rng`] obtained via [`rand::thread_rng`]. Each thread has an
+intialized generator. Integers are uniformly distributed over the range of the
+type, and floating point numbers are uniformly distributed from 0 up to but not
+including 1.
 
 ```rust
 extern crate rand;
 
 use rand::Rng;
 
 fn main() {
-    // Each thread has an automatically-initialised random number generator:
     let mut rng = rand::thread_rng();
 
-    // Integers are uniformly distributed over the type's whole range:
     let n1: u8 = rng.gen();
     let n2: u16 = rng.gen();
     println!("Random u8: {}", n1);
     println!("Random u16: {}", n2);
     println!("Random u32: {}", rng.gen::<u32>());
     println!("Random i32: {}", rng.gen::<i32>());
-
-    // Floating point numbers are uniformly distributed in the half-open range [0, 1)
     println!("Random float: {}", rng.gen::<f64>());
 }
 ```
 
-[`rand::Rng`]: https://doc.rust-lang.org/rand/0.4/rand/trait.Rng.html
-[`rand::thread_rng`]: https://doc.rust-lang.org/rand/0.4/rand/fn.thread_rng.html
+[`rand::Rng`]: https://docs.rs/rand/*/rand/trait.Rng.html
+[`rand::thread_rng`]: https://docs.rs/rand/*/rand/fn.thread_rng.html

src/concurrency/parallel/rayon-parallel-sort.md

@@ -13,21 +13,17 @@ is usually faster than [stable sorting] algorithms.
 extern crate rand;
 extern crate rayon;
 
-use rand::Rng;
+use rand::{Rng, thread_rng};
+use rand::distributions::Alphanumeric;
 use rayon::prelude::*;
 
 fn main() {
-    // [1]
-    let mut vec = vec![String::new(); 100_000];
-
-    // [2]
-    vec.par_iter_mut().for_each(|p| {
-        // [3]
-        *p = rand::weak_rng().gen_ascii_chars().take(5).collect()
-    });
-
-    // [4]
-    vec.par_sort_unstable();
+  let mut vec = vec![String::new(); 100_000];
+  vec.par_iter_mut().for_each(|p| {
+    let mut rng = thread_rng();
+    *p = (0..5).map(|_| rng.sample(&Alphanumeric)).collect()
+  });
+  vec.par_sort_unstable();
 }
 ```
 

src/development_tools/debugging/config_log/log-timestamp.md

@@ -3,7 +3,9 @@
 [![log-badge]][log] [![env_logger-badge]][env_logger] [![chrono-badge]][chrono] [![cat-debugging-badge]][cat-debugging]
 
 Creates a custom logger configuration with [`Builder`].
-Each log entry calls [`Local::now`] to get the current [`DateTime`] in local timezone and uses [`DateTime::format`] with [`strftime::specifiers`] to format a timestamp used in the final log.
+Each log entry calls [`Local::now`] to get the current [`DateTime`] in local
+timezone and uses [`DateTime::format`] with [`strftime::specifiers`] to format
+a timestamp used in the final log.
 
 The example calls [`Builder::format`] to set a closure which formats each
 message text with timestamp, [`Record::level`] and body ([`Record::args`]).
@@ -14,7 +16,6 @@ extern crate log;
 extern crate chrono;
 extern crate env_logger;
 
-use std::env;
 use std::io::Write;
 use chrono::Local;
 use env_logger::Builder;

src/encoding/csv/delimiter.md

@@ -28,12 +28,11 @@ use csv::ReaderBuilder;
 # }
 
 fn run() -> Result<()> {
-    let data = \
-"name	place	id
-Mark	Melbourne	46
-Ashley	Zurich	92";
+    let data = "name\tplace\tid
+Mark\tMelbourne\t46
+Ashley\tZurich\t92";
 
-    let mut reader = ReaderBuilder::new().delimiter(b'	').from_reader(data.as_bytes());
+    let mut reader = ReaderBuilder::new().delimiter(b'\t').from_reader(data.as_bytes());
     for result in reader.records() {
         println!("{:?}", result?);
     }

src/hardware/processor/cpu-count.md

@@ -2,7 +2,7 @@
 
 [![num_cpus-badge]][num_cpus] [![cat-hardware-support-badge]][cat-hardware-support]
 
-Shows the number of logical cpu cores in current machine using [`num_cpus::get`].
+Shows the number of logical CPU cores in current machine using [`num_cpus::get`].
 
 ```rust
 extern crate num_cpus;