Skip to content

Commit 0eb0789

Browse files
committed
nrf, doc: Don't refer to Default impl of saadc::ChannelConfig
`saadc::ChannelConfig` does not implement the `Default` trait, so its documentation should not refer to it. Modify the documentation to instead describe how the struct should be created and configured.
1 parent b55726c commit 0eb0789

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

embassy-nrf/src/saadc.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ impl Default for Config {
7878

7979
/// Used to configure an individual SAADC peripheral channel.
8080
///
81-
/// See the `Default` impl for suitable default values.
81+
/// Construct using the `single_ended` or `differential` methods. These provide sensible defaults
82+
/// for the public fields, which can be overridden if required.
8283
#[non_exhaustive]
8384
pub struct ChannelConfig<'d> {
8485
/// Reference voltage of the SAADC input.

0 commit comments

Comments
 (0)