Skip to content

Commit 181e283

Browse files
authored
docs: fix some documentation comments (#52)
1 parent ba16ad6 commit 181e283

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ pub trait Model {
135135
fn max_length(&self) -> usize;
136136
}
137137

138-
/// A wrapper which converts a [`fixed_length::Model`](Model) to a
138+
/// A wrapper which converts a [`max_length::Model`](Model) to a
139139
/// [`crate::Model`].
140140
#[derive(Debug, Clone)]
141141
pub struct Wrapper<M>
@@ -150,7 +150,7 @@ impl<M> Wrapper<M>
150150
where
151151
M: Model,
152152
{
153-
/// Construct a new wrapper from a [`fixed_length::Model`](Model)
153+
/// Construct a new wrapper from a [`Model`]
154154
pub fn new(model: M) -> Self {
155155
let remaining = model.max_length();
156156
Self { model, remaining }

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@ use crate::{fixed_length, BitStore};
77

88
/// A [`Model`] is used to calculate the probability of a given symbol occuring
99
/// in a sequence. The [`Model`] is used both for encoding and decoding. A
10-
/// 'fixed-length' model always expects an exact number of symbols, and so does
10+
/// 'one-shot' only ever encodes a single symbol, and so does
1111
/// not need to encode an EOF symbol.
1212
///
13-
/// A fixed length model can be converted into a regular model using the
13+
/// A one-shot [`Model`] is a special case of the [`fixed_length::Model`].
14+
///
15+
/// A one-shot model can be converted into a regular model using the
1416
/// convenience [`Wrapper`] type.
1517
///
1618
/// The more accurately a [`Model`] is able to predict the next symbol, the

0 commit comments

Comments
 (0)