Skip to content

Commit

Permalink
sntpc: Update logging feature documentation in sntpc
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
vpetrigo committed Jan 5, 2025
1 parent e8d6c1f commit 87c2303
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion sntpc/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,17 @@
//! - `sync`: enables synchronous interface
//! - `utils`: includes functionality that mostly OS specific and allows system time sync
//! - `log`: enables library debug output during execution
//! - `defmt`: enables library debug output using defmt
//! - `std-socket`: add `NtpUdpSocket` trait implementation for `std::net::UdpSocket`
//! - `embassy-socket`: add `NtpUdpSocket` trait implementation for `embassy_net::udp::UdpSocket`
//! - `tokio-socket`: add `NtpUdpSocket` trait implementation for `tokio::net::UdpSocket`
//! - `defmt`: enables library debug output using defmt
//!
//! <div class="warning">
//!
//! **Warning**: `log` and `defmt` are mutually exclusive features. If for some reason both are
//! enabled `defmt` is considered to have higher priority feature, so all logging will use `defmt`
//! API.
//! </div>
//!
//! <div class="warning">
//!
Expand Down

0 comments on commit 87c2303

Please sign in to comment.