Skip to content

Commit c9e6ca1

Browse files
committed
Use rust-bitcoin module doc style
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 `//!`.
1 parent 3fa6762 commit c9e6ca1

File tree

4 files changed

+2
-4
lines changed

4 files changed

+2
-4
lines changed

src/constants.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
1414
//
1515

16-
//! # Constants
1716
//! Constants related to the API and the underlying curve.
17+
//!
1818
1919
/// The size (in bytes) of a message.
2020
pub const MESSAGE_SIZE: usize = 32;

src/ecdh.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
1313
//
1414

15-
//! # ECDH
1615
//! Support for shared secret computations.
1716
//!
1817

src/ecdsa/recovery.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
1414
//
1515

16-
//! # Recovery module
1716
//! Provides a signing function that allows recovering the public key from the
1817
//! signature.
18+
//!
1919
2020
use core::ptr;
2121
use key;

src/lib.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
1414
//
1515

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

0 commit comments

Comments
 (0)