Skip to content

Commit f7dd6e5

Browse files
committed
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.
1 parent 00bd0cd commit f7dd6e5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/primitives/decode.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ const SEP: char = '1';
114114
/// ```
115115
#[derive(Debug)]
116116
pub struct UncheckedHrpstring<'s> {
117-
/// The human-readable part, guaranteed to be lowercase ASCII characters.
117+
/// The human-readable part, guaranteed to be ASCII characters and not mixed-case.
118118
hrp: Hrp,
119119
/// This is ASCII byte values of the parsed string, guaranteed to be valid bech32 characters.
120120
///
@@ -332,7 +332,7 @@ impl<'s> UncheckedHrpstring<'s> {
332332
/// ```
333333
#[derive(Debug)]
334334
pub struct CheckedHrpstring<'s> {
335-
/// The human-readable part, guaranteed to be lowercase ASCII characters.
335+
/// The human-readable part, guaranteed to be ASCII characters and not mixed-case.
336336
hrp: Hrp,
337337
/// This is ASCII byte values of the parsed string, guaranteed to be valid bech32 characters.
338338
///

0 commit comments

Comments
 (0)