Skip to content

Commit 87c2303

Browse files
committed
sntpc: Update logging feature documentation in sntpc
Clarified the mutual exclusivity of `log` and `defmt` features and their priority in the documentation. This ensures users are aware of the behavior when both features are enabled. Improved formatting for better readability.
1 parent e8d6c1f commit 87c2303

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

sntpc/src/lib.rs

+8-1
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,17 @@
2222
//! - `sync`: enables synchronous interface
2323
//! - `utils`: includes functionality that mostly OS specific and allows system time sync
2424
//! - `log`: enables library debug output during execution
25+
//! - `defmt`: enables library debug output using defmt
2526
//! - `std-socket`: add `NtpUdpSocket` trait implementation for `std::net::UdpSocket`
2627
//! - `embassy-socket`: add `NtpUdpSocket` trait implementation for `embassy_net::udp::UdpSocket`
2728
//! - `tokio-socket`: add `NtpUdpSocket` trait implementation for `tokio::net::UdpSocket`
28-
//! - `defmt`: enables library debug output using defmt
29+
//!
30+
//! <div class="warning">
31+
//!
32+
//! **Warning**: `log` and `defmt` are mutually exclusive features. If for some reason both are
33+
//! enabled `defmt` is considered to have higher priority feature, so all logging will use `defmt`
34+
//! API.
35+
//! </div>
2936
//!
3037
//! <div class="warning">
3138
//!

0 commit comments

Comments
 (0)