From 15cdd88975a42581bb239e359e446f4c4478773b Mon Sep 17 00:00:00 2001 From: Austin Richardson Date: Mon, 14 Sep 2026 08:34:26 -0700 Subject: [PATCH] Fix docstring --- src/sequence.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/sequence.rs b/src/sequence.rs index af974f2..8237cf3 100644 --- a/src/sequence.rs +++ b/src/sequence.rs @@ -246,7 +246,8 @@ pub trait Sequence<'a> { Kmers::new(self.sequence(), k) } - /// Return an iterator that returns valid kmers in 4-bit form + /// Return an iterator over 2-bit encoded kmers, skipping any kmer that + /// contains a non-ACGT base (including N and IUPAC ambiguity codes). fn bit_kmers(&'a self, k: u8, canonical: bool) -> BitNuclKmer<'a> { BitNuclKmer::new(self.sequence(), k, canonical) }