From 0eb07896275f26f1206ed968436d1f0e78a163b8 Mon Sep 17 00:00:00 2001 From: Frank Plowman Date: Fri, 9 Aug 2024 14:15:23 +0100 Subject: [PATCH] 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. --- embassy-nrf/src/saadc.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/embassy-nrf/src/saadc.rs b/embassy-nrf/src/saadc.rs index a3a5b9cfe..bbfa9b3b9 100644 --- a/embassy-nrf/src/saadc.rs +++ b/embassy-nrf/src/saadc.rs @@ -78,7 +78,8 @@ impl Default for Config { /// Used to configure an individual SAADC peripheral channel. /// -/// See the `Default` impl for suitable default values. +/// Construct using the `single_ended` or `differential` methods. These provide sensible defaults +/// for the public fields, which can be overridden if required. #[non_exhaustive] pub struct ChannelConfig<'d> { /// Reference voltage of the SAADC input.