From 96f9fd3e56b9a6eda4757c83abb18aa24d4e6607 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Thu, 24 Nov 2022 05:25:57 +1100 Subject: [PATCH] Link to MESSAGE_SIZE in Error docs We can help readers of the HTML docs by using a link to the constant. While we are at it shorten the doc comment so it fits on one line (in under 100 chars). --- src/lib.rs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 777ee43..3451c73 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -304,8 +304,7 @@ impl fmt::Display for Message { pub enum Error { /// Signature failed verification IncorrectSignature, - /// Badly sized message ("messages" are actually fixed-sized digests; see the `MESSAGE_SIZE` - /// constant). + /// Bad sized message ("messages" are actually fixed-sized digests [`constants::MESSAGE_SIZE`]). InvalidMessage, /// Bad public key. InvalidPublicKey,