Merge pull request #813 from ValouBambou/main

doc: add note for the alloc feature flag
knurling-rs · Mar 6, 2024 · 7a0b42c · 7a0b42c
2 parents 8d488c4 + a7ebe0e
commit 7a0b42c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,8 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+- [#813] doc: add note for the alloc feature flag
 - [#800]: `defmt-macros`: Fix generic trait bounds in Format derive macro
 
+[#813]: https://github.com/knurling-rs/defmt/pull/813
 [#800]: https://github.com/knurling-rs/defmt/pull/800
 
 ## [v0.3.6] - 2024-02-05

diff --git a/defmt/src/traits.rs b/defmt/src/traits.rs
@@ -42,6 +42,7 @@ use crate::{export, Formatter, Str};
 ///     }
 /// }
 /// ```
+/// **Note** Some implementations of standard types like `Vec<T>` are hidden behind the `alloc` feature flag.
 pub trait Format {
     /// Writes the defmt representation of `self` to `fmt`.
     fn format(&self, fmt: Formatter);