docs: Add warning block

sorairolake · Feb 24, 2025 · ede7054 · ede7054
1 parent 141102a
commit ede7054
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/crates/abcrypt/README.md b/crates/abcrypt/README.md
@@ -44,8 +44,9 @@ default.
 
 This supports `no_std` mode. Disables the `default` feature to enable this.
 
-Note that the memory blocks used by Argon2 when calculating a derived key is
-limited to 256 KiB when the `alloc` feature is disabled.
+> [!IMPORTANT]
+> Note that the memory blocks used by Argon2 when calculating a derived key is
+> limited to 256 KiB when the `alloc` feature is disabled.
 
 ### Documentation
 

diff --git a/crates/abcrypt/src/lib.rs b/crates/abcrypt/src/lib.rs
@@ -39,9 +39,13 @@
 //! This crate supports `no_std` mode and can be used without the `alloc` crate
 //! and the `std` crate. Disables the `default` feature to enable this.
 //!
+//! <div class="warning">
+//!
 //! Note that the memory blocks used by Argon2 when calculating a derived key is
 //! limited to 256 KiB when the `alloc` feature is disabled.
 //!
+//! </div>
+//!
 //! ```
 //! use abcrypt::{
 //!     Argon2, Decryptor, Encryptor,

diff --git a/docs/book/modules/lib/pages/usage.adoc b/docs/book/modules/lib/pages/usage.adoc
@@ -30,5 +30,5 @@ cargo add abcrypt
 
 This supports `no_std` mode. Disables the `default` feature to enable this.
 
-Note that the memory blocks used by Argon2 when calculating a derived key is
-limited to 256 KiB when the `alloc` feature is disabled.
+IMPORTANT: Note that the memory blocks used by Argon2 when calculating a
+derived key is limited to 256 KiB when the `alloc` feature is disabled.