Skip to content

Commit e0eeec4

Browse files
committed
Fix outdated comment in singleton!.
1 parent 0e53054 commit e0eeec4

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/macros.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,10 @@ macro_rules! iprintln {
3131
/// at most once in the whole lifetime of the program.
3232
///
3333
/// # Notes
34-
/// This macro is unsound on multi core systems.
34+
///
35+
/// This macro requires a `critical-section` implementation to be set. For most single core systems,
36+
/// you can enable the `critical-section-single-core` feature for this crate. For other systems, you
37+
/// have to provide one from elsewhere, typically your chip's HAL crate.
3538
///
3639
/// For debuggability, you can set an explicit name for a singleton. This name only shows up the
3740
/// the debugger and is not referencable from other code. See example below.

0 commit comments

Comments
 (0)