Skip to content

Commit bdc13a4

Browse files
committed
Fix incorrect HRP docs
Fix cut'n'pasta error, this is the `hrp` struct not an hrpstring.
1 parent 5d2e13e commit bdc13a4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/primitives/hrp.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ impl Hrp {
181181
#[allow(clippy::len_without_is_empty)] // HRP is never empty.
182182
pub fn len(&self) -> usize { self.size }
183183

184-
/// Returns `true` if this [`Hrp`] is valid according to the bips.
184+
/// Returns `true` if this HRP is valid according to the bips.
185185
///
186186
/// [BIP-173] states that the HRP must be either "bc" or "tb".
187187
///
@@ -191,19 +191,19 @@ impl Hrp {
191191
self.is_valid_on_mainnet() || self.is_valid_on_testnet()
192192
}
193193

194-
/// Returns `true` if this hrpstring is valid on the Bitcoin network i.e., HRP is "bc".
194+
/// Returns `true` if this HRP is valid on the Bitcoin network i.e., HRP is "bc".
195195
#[inline]
196196
pub fn is_valid_on_mainnet(&self) -> bool { *self == self::BC }
197197

198-
/// Returns `true` if this hrpstring is valid on the Bitcoin testnet network i.e., HRP is "tb".
198+
/// Returns `true` if this HRP is valid on the Bitcoin testnet network i.e., HRP is "tb".
199199
#[inline]
200200
pub fn is_valid_on_testnet(&self) -> bool { *self == self::TB }
201201

202-
/// Returns `true` if this hrpstring is valid on the Bitcoin signet network i.e., HRP is "tb".
202+
/// Returns `true` if this HRP is valid on the Bitcoin signet network i.e., HRP is "tb".
203203
#[inline]
204204
pub fn is_valid_on_signet(&self) -> bool { *self == self::TB }
205205

206-
/// Returns `true` if this hrpstring is valid on the Bitcoin regtest network i.e., HRP is "bcrt".
206+
/// Returns `true` if this HRP is valid on the Bitcoin regtest network i.e., HRP is "bcrt".
207207
#[inline]
208208
pub fn is_valid_on_regtest(&self) -> bool { *self == self::BCRT }
209209
}

0 commit comments

Comments
 (0)