From 0f01cb9f51d0cc62a02533736dcd28c0bf58f194 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Thu, 29 Sep 2022 05:10:19 +1000 Subject: [PATCH] Use rustdoc summary Rustdoc comment is too long, use a summary and a longer section as is convention. --- bitcoin/src/util/base58.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/bitcoin/src/util/base58.rs b/bitcoin/src/util/base58.rs index 84aca244..6569ca2a 100644 --- a/bitcoin/src/util/base58.rs +++ b/bitcoin/src/util/base58.rs @@ -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]),