Skip to content

Commit fb1a6c5

Browse files
committed
docs: improve documentation
1 parent 9ff0771 commit fb1a6c5

2 files changed

Lines changed: 3 additions & 1 deletion

File tree

src/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
//! - Optional sequence headers/identifiers (VBQ format)
1515
//! - Abstract [`BinseqRecord`] trait for representing records from both `.bq` and `.vbq` files.
1616
//! - Abstract [`BinseqReader`] enum for processing records from both `.bq` and `.vbq` files.
17+
//! - Abstract [`BinseqWriter`] enum for writing records to both `.bq`, `.vbq`, and `.cbq` files.
1718
//!
1819
//! ## Recent VBQ Format Changes (v0.7.0+)
1920
//!
@@ -106,6 +107,7 @@ pub use error::{Error, IntoBinseqError, Result};
106107
pub use parallel::{BinseqReader, ParallelProcessor, ParallelReader};
107108
pub use policy::{Policy, RNG_SEED};
108109
pub use record::{BinseqRecord, SequencingRecord, SequencingRecordBuilder};
110+
pub use write::{BinseqWriter, BinseqWriterBuilder};
109111

110112
/// Re-export `bitnuc::BitSize`
111113
pub use bitnuc::BitSize;

src/write.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
//! Unified writer interface for BINSEQ formats
22
//!
3-
//! This module provides a unified [`BinseqWriter`] enum that abstracts over the three
3+
//! This module provides a unified `BinseqWriter` enum that abstracts over the three
44
//! BINSEQ format writers (BQ, VBQ, CBQ), allowing format-agnostic writing of sequence data.
55
//!
66
//! # Example

0 commit comments

Comments
 (0)