From c9e6ca168000aa3b0aea128048a7f7a40986398c Mon Sep 17 00:00:00 2001 From: Tobin Harding Date: Thu, 18 Nov 2021 11:55:22 +1100 Subject: [PATCH] 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 `//!`. --- src/constants.rs | 2 +- src/ecdh.rs | 1 - src/ecdsa/recovery.rs | 2 +- src/lib.rs | 1 - 4 files changed, 2 insertions(+), 4 deletions(-) diff --git a/src/constants.rs b/src/constants.rs index 8da0e8c..07b9d02 100644 --- a/src/constants.rs +++ b/src/constants.rs @@ -13,8 +13,8 @@ // If not, see . // -//! # Constants //! Constants related to the API and the underlying curve. +//! /// The size (in bytes) of a message. pub const MESSAGE_SIZE: usize = 32; diff --git a/src/ecdh.rs b/src/ecdh.rs index e0df282..0897ddc 100644 --- a/src/ecdh.rs +++ b/src/ecdh.rs @@ -12,7 +12,6 @@ // If not, see . // -//! # ECDH //! Support for shared secret computations. //! diff --git a/src/ecdsa/recovery.rs b/src/ecdsa/recovery.rs index 4b1488f..2a3f4bc 100644 --- a/src/ecdsa/recovery.rs +++ b/src/ecdsa/recovery.rs @@ -13,9 +13,9 @@ // If not, see . // -//! # Recovery module //! Provides a signing function that allows recovering the public key from the //! signature. +//! use core::ptr; use key; diff --git a/src/lib.rs b/src/lib.rs index 018df93..e3725e5 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -13,7 +13,6 @@ // If not, see . // -//! # 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