Skip to content

Commit

Permalink
Oops, broken doctests.
Browse files Browse the repository at this point in the history
  • Loading branch information
faassen committed Jan 28, 2025
1 parent 1d1174d commit 78ca718
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ use crate::{
/// Default behavior: all capabilities with maximum performance but most memory
/// usage.
/// ```rust
/// use fm_index::builder::SearchIndexBuilder;
/// use fm_index::SearchIndexBuilder;
/// let builder = SearchIndexBuilder::new();
/// let index = builder.build("text".as_bytes().to_vec());
/// ```
///
/// Custom converter with a smaller range means less memory usage:
/// ```rust
/// use fm_index::builder::SearchIndexBuilder;
/// use fm_index::SearchIndexBuilder;
/// use fm_index::converter::RangeConverter;
/// let converter = RangeConverter::new(b' ', b'~');
/// let builder = SearchIndexBuilder::with_converter(converter);
Expand All @@ -44,28 +44,28 @@ use crate::{
///
/// Sampling level, smaller but slower locate:
/// ```rust
/// use fm_index::builder::SearchIndexBuilder;
/// use fm_index::SearchIndexBuilder;
/// let builder = SearchIndexBuilder::new().sampling_level(2);
/// let index = builder.build("text".as_bytes().to_vec());
/// ```
///
/// Count only, smaller at the cost of locate.
/// ```rust
/// use fm_index::builder::SearchIndexBuilder;
/// use fm_index::SearchIndexBuilder;
/// let builder = SearchIndexBuilder::new().count_only();
/// let index = builder.build("text".as_bytes().to_vec());
/// ```
///
/// Run-length encoding, smaller but slower.
/// ```rust
/// use fm_index::builder::SearchIndexBuilder;
/// use fm_index::SearchIndexBuilder;
/// let builder = SearchIndexBuilder::new().run_length_encoding();
/// let index = builder.build("text".as_bytes().to_vec());
/// ```
///
/// Almost the smallest index (a range converter can still shrink it further):
/// ```rust
/// use fm_index::builder::SearchIndexBuilder;
/// use fm_index::SearchIndexBuilder;
/// let builder = SearchIndexBuilder::new().count_only().run_length_encoding();
/// let index = builder.build("text".as_bytes().to_vec());
/// ```
Expand Down

0 comments on commit 78ca718

Please sign in to comment.