From 023156777c5afb8127c95c7167892794d4fce55d Mon Sep 17 00:00:00 2001 From: Jonas Schievink Date: Thu, 21 Jan 2021 16:00:50 +0100 Subject: [PATCH] Clarify docs on `Write::write` --- src/lib.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index ec3aefbd..637c4d39 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -633,6 +633,9 @@ pub trait Write { /// /// This will be called by the defmt logging macros to transmit encoded data. The write /// operation must not fail. + /// + /// Note that a call to `write` does *not* correspond to a defmt logging macro invocation. A + /// single `defmt::info!` call can result in an arbitrary number of `write` calls. fn write(&mut self, bytes: &[u8]); }