From c3be285c1dbad037609f9f11a61c4aa12d6f370e Mon Sep 17 00:00:00 2001 From: Tobin Harding Date: Thu, 18 Nov 2021 10:54:32 +1100 Subject: [PATCH] Fix size constant docs Make all the various size constant docs uniform by using form 'The size ...' and also by ending with a period. --- src/constants.rs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/constants.rs b/src/constants.rs index 5754183..8da0e8c 100644 --- a/src/constants.rs +++ b/src/constants.rs @@ -16,31 +16,31 @@ //! # Constants //! Constants related to the API and the underlying curve. -/// The size (in bytes) of a message +/// The size (in bytes) of a message. pub const MESSAGE_SIZE: usize = 32; -/// The size (in bytes) of a secret key +/// The size (in bytes) of a secret key. pub const SECRET_KEY_SIZE: usize = 32; /// The size (in bytes) of a serialized public key. pub const PUBLIC_KEY_SIZE: usize = 33; -/// The size (in bytes) of an serialized uncompressed public key +/// The size (in bytes) of an serialized uncompressed public key. pub const UNCOMPRESSED_PUBLIC_KEY_SIZE: usize = 65; -/// The maximum size of a signature +/// The maximum size of a signature. pub const MAX_SIGNATURE_SIZE: usize = 72; -/// The maximum size of a compact signature +/// The maximum size of a compact signature. pub const COMPACT_SIGNATURE_SIZE: usize = 64; -/// Size of a Schnorr signature +/// The size of a Schnorr signature. pub const SCHNORRSIG_SIGNATURE_SIZE: usize = 64; -/// Size of a Schnorr public key +/// The size of a Schnorr public key. pub const SCHNORRSIG_PUBLIC_KEY_SIZE: usize = 32; -/// Size of a key pair +/// The size of a key pair. pub const KEY_PAIR_SIZE: usize = 96; /// The Prime for the secp256k1 field element.