Skip to content

Commit

Permalink
Use rust-bitcoin module doc style
Browse files Browse the repository at this point in the history
Recently we introduced uniform styling for module docs over in
`rust-bitcoin` repo. We can do the same here but its a bit controversial
because it removes the heading from module docs and every single public
module in rust-secp256k1 uses a heading. Instead we use a full
sentences. Also makes uniform the trailing `//!`.
  • Loading branch information
tcharding committed Jan 26, 2022
1 parent bd1be3a commit da161c9
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/constants.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
//

//! # Constants
//! Constants related to the API and the underlying curve.
//!

/// The size (in bytes) of a message.
pub const MESSAGE_SIZE: usize = 32;
Expand Down
1 change: 0 additions & 1 deletion src/ecdh.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
//

//! # ECDH
//! Support for shared secret computations.
//!

Expand Down
2 changes: 1 addition & 1 deletion src/ecdsa/recovery.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
//

//! # Recovery module
//! Provides a signing function that allows recovering the public key from the
//! signature.
//!

use core::ptr;
use key;
Expand Down
1 change: 0 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
//

//! # Secp256k1
//! Rust bindings for Pieter Wuille's secp256k1 library, which is used for
//! fast and accurate manipulation of ECDSA signatures on the secp256k1
//! curve. Such signatures are used extensively by the Bitcoin network
Expand Down

0 comments on commit da161c9

Please sign in to comment.