Skip to content

Commit

Permalink
Fix size constant docs
Browse files Browse the repository at this point in the history
Make all the various size constant docs uniform by using form 'The size
...' and also by ending with a period.
  • Loading branch information
tcharding committed Feb 9, 2022
1 parent 5e07e75 commit c3be285
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions src/constants.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit c3be285

Please sign in to comment.