From 7508aeb43d2c220ec1138eb067f43047f383fbec Mon Sep 17 00:00:00 2001 From: chrysn Date: Wed, 4 Sep 2024 15:26:53 +0200 Subject: [PATCH] doc: Explicitly spell out constructor As this is expected to be used by newcomers, it helps being explicit. --- src/led.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/led.rs b/src/led.rs index 725a958..0637749 100644 --- a/src/led.rs +++ b/src/led.rs @@ -23,7 +23,7 @@ impl LED { Self::new_unchecked() } - /// Accesses the LED numbered `I`. + /// Accesses the LED numbered `I` as `LED::::new_unchecked()`. /// /// It is not an error if this board does not have a LED with that number; the resulting struct /// will be available but its methods have no effect. @@ -32,7 +32,7 @@ impl LED { Self(()) } - /// Accesses the LED numbered `I`. + /// Accesses the LED numbered `I` as `LED::::new_checked()?`. /// /// An LED is returned if present on the board, which is known at build time. pub const fn new_checked() -> Result {