Expose PackedSeq{Vec}Base in private:: so PackedSeq docs show members

Author: RagnarGrootKoerkamp

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 4.4.1
+- Improve docs
+
 ## 4.4.0
 - Add `PackedSeq{Vec}Base::from_raw_parts` to construct directly from a `Vec` or slice.
 - Add `PackedNSeqVec::from_ascii_and_quality` that masks out low-quality bases.

src/lib.rs

@@ -141,6 +141,15 @@ pub use packed_seq::{
 pub use padded_it::{Advance, ChunkIt, PaddedIt};
 pub use traits::{Delay, Seq, SeqVec};
 
+/// Non-public implementation details.
+///
+/// Specifically, [`PackedSeq`] and [`BitSeq`] are both implemented via [`private::PackedSeqBase`], and
+/// [`PackedSeqVec`] and [`BitSeqVec`] via [`private::PackedSeqVecBase`], but this should not be relied upon.
+pub mod private {
+    pub use crate::packed_seq::PackedSeqBase;
+    pub use crate::packed_seq::PackedSeqVecBase;
+}
+
 // For internal use only.
 use core::array::from_fn;
 use mem_dbg::{MemDbg, MemSize};

src/packed_seq.rs

@@ -114,8 +114,7 @@ impl SupportedBits for Bits<8> {}
 /// Number of padding bytes at the end of `PackedSeqVecBase::seq`.
 pub(crate) const PADDING: usize = 48;
 
-/// A 2-bit packed non-owned slice of DNA bases.
-#[doc(hidden)]
+/// A variable-bit-width packed non-owned slice of DNA bases.
 #[derive(Copy, Clone, Debug, MemSize, MemDbg)]
 pub struct PackedSeqBase<'s, const B: usize>
 where
@@ -129,8 +128,7 @@ where
     len: usize,
 }
 
-/// A 2-bit packed owned sequence of DNA bases.
-#[doc(hidden)]
+/// A variable-bit-width packed owned sequence of DNA bases.
 #[derive(Clone, Debug, MemSize, MemDbg)]
 #[cfg_attr(feature = "pyo3", pyo3::pyclass)]
 #[cfg_attr(feature = "epserde", derive(epserde::Epserde))]