Skip to content

Commit 521d963

Browse files
committed
Fix incorrect HRP docs
Fix cut'n'pasta error, this is the `hrp` struct not an hrpstring.
1 parent 9f7c21a commit 521d963

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
@@ -191,7 +191,7 @@ impl Hrp {
191191
#[allow(clippy::len_without_is_empty)] // HRP is never empty.
192192
pub fn len(&self) -> usize { self.size }
193193

194-
/// Returns `true` if this [`Hrp`] is valid according to the bips.
194+
/// Returns `true` if this HRP is valid according to the bips.
195195
///
196196
/// [BIP-173] states that the HRP must be either "bc" or "tb".
197197
///
@@ -201,19 +201,19 @@ impl Hrp {
201201
self.is_valid_on_mainnet() || self.is_valid_on_testnet()
202202
}
203203

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

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

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

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

0 commit comments

Comments
 (0)