Use rustdoc summary
Rustdoc comment is too long, use a summary and a longer section as is convention.
This commit is contained in:
parent
6151d4c841
commit
0f01cb9f51
|
@ -245,8 +245,10 @@ pub enum Error {
|
|||
BadByte(u8),
|
||||
/// Checksum was not correct (expected, actual).
|
||||
BadChecksum(u32, u32),
|
||||
/// The length (in bytes) of the object was not correct, note that if the length is excessively
|
||||
/// long the provided length may be an estimate (and the checksum step may be skipped).
|
||||
/// The length (in bytes) of the object was not correct.
|
||||
///
|
||||
/// Note that if the length is excessively long the provided length may be an estimate (and the
|
||||
/// checksum step may be skipped).
|
||||
InvalidLength(usize),
|
||||
/// Extended Key version byte(s) were not recognized.
|
||||
InvalidExtendedKeyVersion([u8; 4]),
|
||||
|
|
Loading…
Reference in New Issue