Add description to doc

contain-rs · Feb 13, 2023 · 5af89f5 · 5af89f5
1 parent 54a7481
commit 5af89f5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -60,6 +60,10 @@ bit-vec = { version = "0.6", default-features = false }
 
 <!-- cargo-rdme start -->
 
+### Description
+
+Dynamic collections implemented with compact bit vectors.
+
 ### Examples
 
 This is a simple example of the [Sieve of Eratosthenes][sieve]

diff --git a/src/lib.rs b/src/lib.rs
@@ -25,6 +25,10 @@
 // (4) `BitSet` is tightly coupled with `BitVec`, so any changes you make in
 // `BitVec` will need to be reflected in `BitSet`.
 
+//! # Description
+//!
+//! Dynamic collections implemented with compact bit vectors.
+//!
 //! # Examples
 //!
 //! This is a simple example of the [Sieve of Eratosthenes][sieve]