prepare for 0.1.1 release: clippy missing-doc linter warnings

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# 0.1.1 (2024-04-10)
+
+Non-Breaking Changes:
+
+* fix clippy linter warning errors (`missing_docs`): `missing documentation for a variant`;
+
 # 0.1.0 (2024-04-09)
 
 Implement the first version of this library, `venndb`.

Cargo.toml

@@ -12,7 +12,7 @@ repository = "https://github.com/plabayo/venndb"
 keywords = ["database", "db", "memory", "bits"]
 categories = ["database", "db"]
 authors = ["Glen De Cauwsemaecker <[email protected]>"]
-version = "0.1.0"
+version = "0.1.1"
 rust-version = "1.75.0"
 
 [package.metadata.docs.rs]

venndb-macros/Cargo.toml

@@ -9,7 +9,7 @@ repository = "https://github.com/plabayo/venndb"
 keywords = ["database", "db", "memory", "bits"]
 categories = ["database", "db"]
 authors = ["Glen De Cauwsemaecker <[email protected]>"]
-version = "0.1.0"
+version = "0.1.1"
 rust-version = "1.75.0"
 
 [package.metadata.docs.rs]

venndb-macros/src/generate_db.rs

@@ -805,7 +805,9 @@ fn generate_query_struct_impl(
         }
 
         #vis enum #name_query_result_iter_kind<'a> {
+            /// An iterator found over the one-bits in the resulting (non-filtered) bit-vector.
             Bits(::venndb::__internal::IterOnes<'a, usize, ::venndb::__internal::Lsb0>),
+            /// An iterator over the indices of the filtered results.
             Indices(::std::slice::Iter<'a, usize>),
         }
     }
@@ -830,6 +832,7 @@ impl ToTokens for DbErrorKind {
         match self {
             Self::DuplicateKey => {
                 tokens.extend(quote! {
+                    /// The error kind for when the row to be insired has a key already known (key duplicate).
                     DuplicateKey,
                 });
             }