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).
This commit is contained in:
Tobin C. Harding 2022-11-24 05:25:57 +11:00
parent 036bd0d011
commit 96f9fd3e56
1 changed files with 1 additions and 2 deletions

View File

@ -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,