From f7dd6e5ddf4cb0b14f21587137d0b0799c5ad404 Mon Sep 17 00:00:00 2001 From: Elias Rohrer Date: Mon, 6 Jan 2025 10:34:19 +0100 Subject: [PATCH] Correct internal `decode` docs Previously, the field docs stated that the `Hrp` would be always lowercase. However, we only assert that it's not mixed-case, i.e., all upper-case characters are allowed. --- src/primitives/decode.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/primitives/decode.rs b/src/primitives/decode.rs index b4ca5e38..213e6cdb 100644 --- a/src/primitives/decode.rs +++ b/src/primitives/decode.rs @@ -114,7 +114,7 @@ const SEP: char = '1'; /// ``` #[derive(Debug)] pub struct UncheckedHrpstring<'s> { - /// The human-readable part, guaranteed to be lowercase ASCII characters. + /// The human-readable part, guaranteed to be ASCII characters and not mixed-case. hrp: Hrp, /// This is ASCII byte values of the parsed string, guaranteed to be valid bech32 characters. /// @@ -332,7 +332,7 @@ impl<'s> UncheckedHrpstring<'s> { /// ``` #[derive(Debug)] pub struct CheckedHrpstring<'s> { - /// The human-readable part, guaranteed to be lowercase ASCII characters. + /// The human-readable part, guaranteed to be ASCII characters and not mixed-case. hrp: Hrp, /// This is ASCII byte values of the parsed string, guaranteed to be valid bech32 characters. ///