Skip to content

Commit 96f9fd3

Browse files
committed
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).
1 parent 036bd0d commit 96f9fd3

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

src/lib.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -304,8 +304,7 @@ impl fmt::Display for Message {
304304
pub enum Error {
305305
/// Signature failed verification
306306
IncorrectSignature,
307-
/// Badly sized message ("messages" are actually fixed-sized digests; see the `MESSAGE_SIZE`
308-
/// constant).
307+
/// Bad sized message ("messages" are actually fixed-sized digests [`constants::MESSAGE_SIZE`]).
309308
InvalidMessage,
310309
/// Bad public key.
311310
InvalidPublicKey,

0 commit comments

Comments
 (0)