docs(lints): address clippy lint errors related to doc comments (#65)

Author: danieleades

arithmetic-coding-core/src/model/fixed_length.rs

@@ -4,8 +4,10 @@ use std::ops::Range;
 
 use crate::BitStore;
 
-/// A [`Model`] is used to calculate the probability of a given symbol occuring
-/// in a sequence. The [`Model`] is used both for encoding and decoding. A
+/// A [`Model`] is used to calculate the probability of a given symbol occurring
+/// in a sequence.
+///
+/// The [`Model`] is used both for encoding and decoding. A
 /// 'fixed-length' model always expects an exact number of symbols, and so does
 /// not need to encode an EOF symbol.
 ///
@@ -124,7 +126,7 @@ pub trait Model {
     /// no-op by default.
     fn update(&mut self, _symbol: &Self::Symbol) {}
 
-    /// The total number of sumbols to encode
+    /// The total number of symbols to encode
     fn length(&self) -> usize;
 }
 

arithmetic-coding-core/src/model/max_length.rs

@@ -4,8 +4,10 @@ use std::ops::Range;
 
 use crate::BitStore;
 
-/// A [`Model`] is used to calculate the probability of a given symbol occuring
-/// in a sequence. The [`Model`] is used both for encoding and decoding. A
+/// A [`Model`] is used to calculate the probability of a given symbol occurring
+/// in a sequence.
+///
+/// The [`Model`] is used both for encoding and decoding. A
 /// 'max-length' model has a maximum length. The compressed size of a message
 /// equal to the maximum length is larger than with a
 /// [`fixed_length::Model`](crate::fixed_length::Model), but smaller than with a

arithmetic-coding-core/src/model/one_shot.rs

@@ -5,8 +5,10 @@ use std::ops::Range;
 pub use crate::fixed_length::Wrapper;
 use crate::{fixed_length, BitStore};
 
-/// A [`Model`] is used to calculate the probability of a given symbol occuring
-/// in a sequence. The [`Model`] is used both for encoding and decoding. A
+/// A [`Model`] is used to calculate the probability of a given symbol occurring
+/// in a sequence.
+///
+/// The [`Model`] is used both for encoding and decoding. A
 /// 'one-shot' only ever encodes a single symbol, and so does
 /// not need to encode an EOF symbol.
 ///