Skip to content

Commit 0837d64

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

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/primitives/hrp.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ impl Hrp {
184184
#[inline]
185185
pub fn is_empty(&self) -> bool { false }
186186

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

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

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

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

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

0 commit comments

Comments
 (0)