Merge pull request #260 from marshallpierce/mp/doc-grammar

Minor doc improvements
marshallpierce · Nov 12, 2023 · bfde751 · bfde751
2 parents baffe6c + 5466e43
commit bfde751
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/src/encode.rs b/src/encode.rs
@@ -98,7 +98,8 @@ pub const fn encoded_len(bytes_len: usize, padding: bool) -> Option<usize> {
     let rem = bytes_len % 3;
 
     let complete_input_chunks = bytes_len / 3;
-    // `let Some(_) = _ else` requires 1.65.0, whereas this messier one works on 1.48
+    // `?` is disallowed in const, and `let Some(_) = _ else` requires 1.65.0, whereas this
+    // messier syntax works on 1.48
     let complete_chunk_output =
         if let Some(complete_chunk_output) = complete_input_chunks.checked_mul(4) {
             complete_chunk_output

diff --git a/src/lib.rs b/src/lib.rs
@@ -75,7 +75,7 @@
 //!
 //! # `Display`
 //!
-//! See [display] for how to transparently base64 data via a `Display` implementation.
+//! See [display] for how to transparently base64-encode data via a `Display` implementation.
 //!
 //! # Examples
 //!