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 `//!`.
This commit is contained in:
Tobin Harding 2021-11-18 11:55:22 +11:00
parent 3fa6762437
commit c9e6ca1680
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
4 changed files with 2 additions and 4 deletions

View File

@ -13,8 +13,8 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Constants
//! Constants related to the API and the underlying curve. //! 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; pub const MESSAGE_SIZE: usize = 32;

View File

@ -12,7 +12,6 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # ECDH
//! Support for shared secret computations. //! Support for shared secret computations.
//! //!

View File

@ -13,9 +13,9 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Recovery module
//! Provides a signing function that allows recovering the public key from the //! Provides a signing function that allows recovering the public key from the
//! signature. //! signature.
//!
use core::ptr; use core::ptr;
use key; use key;

View File

@ -13,7 +13,6 @@
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. // If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
// //
//! # Secp256k1
//! Rust bindings for Pieter Wuille's secp256k1 library, which is used for //! Rust bindings for Pieter Wuille's secp256k1 library, which is used for
//! fast and accurate manipulation of ECDSA signatures on the secp256k1 //! fast and accurate manipulation of ECDSA signatures on the secp256k1
//! curve. Such signatures are used extensively by the Bitcoin network //! curve. Such signatures are used extensively by the Bitcoin network