milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Use rustdoc summary 

Rustdoc comment is too long, use a summary and a longer section as is
convention.
This commit is contained in:
Tobin C. Harding 2022-09-29 05:10:19 +10:00
parent 6151d4c841
commit 0f01cb9f51
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
bitcoin/src/util/base58.rs
View File

@ -245,8 +245,10 @@ pub enum Error {
BadByte(u8), BadByte(u8),
/// Checksum was not correct (expected, actual). /// Checksum was not correct (expected, actual).
BadChecksum(u32, u32), BadChecksum(u32, u32),
/// The length (in bytes) of the object was not correct, note that if the length is excessively /// The length (in bytes) of the object was not correct.
/// long the provided length may be an estimate (and the checksum step may be skipped). ///
/// Note that if the length is excessively long the provided length may be an estimate (and the
/// checksum step may be skipped).
InvalidLength(usize), InvalidLength(usize),
/// Extended Key version byte(s) were not recognized. /// Extended Key version byte(s) were not recognized.
InvalidExtendedKeyVersion([u8; 4]), InvalidExtendedKeyVersion([u8; 4]),