Merge rust-bitcoin/rust-secp256k1#740: fix docs for new clippy lint

38106866c1c23ea2c76879cae2332ea80064711a Revert "Automated update to Github CI to rustc nightly-2024-09-10" (Andrew Poelstra)
d3d9a050a7c87807f6ccc978e8bf8bb2a8764f0b fix docs for new clippy lint. (Andrew Poelstra)

Pull request description:

  There are a bunch of doccomments whose first lines are (much) too long. Most of these are also difficult to understand and/or out-of-date. Just rewrite them all.

ACKs for top commit:
  Kixunil:
    ACK 38106866c1c23ea2c76879cae2332ea80064711a

Tree-SHA512: 291bd2c30c8d46c54d99eba17b6cc5f018912b906f4395fa753218551c1ba50724bdd55699f12bf9de254debf9612541c47e1fcd9c2eb04784f71c21e94b5ea5

Author: william2332-limf

nightly-version

@@ -1 +1 @@
-nightly-2024-09-10
+nightly-2024-08-04

secp256k1-sys/src/lib.rs

@@ -41,13 +41,14 @@ pub const SECP256K1_SER_UNCOMPRESSED: c_uint = (1 << 1);
 /// Flag for keys to indicate compressed serialization format
 pub const SECP256K1_SER_COMPRESSED: c_uint = (1 << 1) | (1 << 8);
 
-/// A nonce generation function. Ordinary users of the library
-/// never need to see this type; only if you need to control
-/// nonce generation do you need to use it. I have deliberately
-/// made this hard to do: you have to write your own wrapper
-/// around the FFI functions to use it. And it's an unsafe type.
-/// Nonces are generated deterministically by RFC6979 by
-/// default; there should be no need to ever change this.
+/// A nonce generation function.
+///
+/// Ordinary users of the library never need to see this type; the default
+/// nonce generation function should be sufficient for almost all usecases.
+///
+/// To use this type, you must write your own (unsafe) wrapper. It is unsafe
+/// because any secure implementation must dereference the passed-in raw
+/// pointers and/or call FFI functions.
 pub type NonceFn = Option<unsafe extern "C" fn(
     nonce32: *mut c_uchar,
     msg32: *const c_uchar,
@@ -66,11 +67,15 @@ pub type EcdhHashFn = Option<unsafe extern "C" fn(
     data: *mut c_void,
 ) -> c_int>;
 
-///  Same as secp256k1_nonce function with the exception of accepting an
-///  additional pubkey argument and not requiring an attempt argument. The pubkey
-///  argument can protect signature schemes with key-prefixed challenge hash
-///  inputs against reusing the nonce when signing with the wrong precomputed
-///  pubkey.
+/// Same as [`NonceFn`], but accepts an additional pubkey argument and does not
+/// accept an attempt argument.
+///
+/// The pubkey argument will protect signature schemes with tweaked keys from
+/// reusing the nonce when signing with a different precomputed pubkey, which
+/// for BIP 340 signatures is just as bad as reusing a nonce across different
+/// messages.
+///
+/// As with [`NonceFn`] ordinary users should never need to touch this type.
 pub type SchnorrNonceFn = Option<unsafe extern "C" fn(
     nonce32: *mut c_uchar,
     msg32: *const c_uchar,
@@ -119,10 +124,19 @@ impl SchnorrSigExtraParams {
     }
 }
 
-/// A Secp256k1 context, containing various precomputed values and such
-/// needed to do elliptic curve computations. If you create one of these
-/// with `secp256k1_context_create` you MUST destroy it with
-/// `secp256k1_context_destroy`, or else you will have a memory leak.
+/// An opaque Secp256k1 context.
+///
+/// Currently this object contains a blinding factor used internally to
+/// randomize computations to protect against sidechannel attacks. In the
+/// past it has contained precomputation tables to speed up crypto operations.
+///
+/// It should be assumed to be expensive to create and therefore should be
+/// reused when possible.
+///
+/// If you create one of these with `secp256k1_context_create` you must
+/// destroy it with `secp256k1_context_destroy`. (Failure to destroy it is
+/// a memory leak; destroying it using any other allocator is undefined
+/// behavior.)
 #[derive(Clone, Debug)]
 #[repr(C)] pub struct Context(c_int);
 

src/ellswift.rs

@@ -71,8 +71,9 @@ where
     1
 }
 
-/// `ElligatorSwift` is an encoding of a uniformly chosen point on the curve
-/// as a 64-byte array that is indistinguishable from a uniformly random array.
+/// An encoding of an elliptic curvepoint such that a uniformly random on-curve
+/// point will be encoded as uniformly random bits.
+///
 /// This object holds two field elements u and t, which are the inputs to
 /// the `ElligatorSwift` encoding function.
 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
@@ -280,10 +281,15 @@ impl ElligatorSwiftSharedSecret {
     pub const fn as_secret_bytes(&self) -> &[u8; 32] { &self.0 }
 }
 
-/// Represents which party we are in the ECDH, A is the initiator, B is the responder.
-/// This is important because the hash of the shared secret is different depending on which party
-/// we are. In this context, "we" means the party that is using this library, and possesses the
-/// secret key passed to `ElligatorSwift::shared_secret`.
+/// Represents which party we are in the ECDH.
+///
+/// Here `A` is the initiator and `B` is the responder.
+///
+/// this context, "we" means the party that possesses the secret key passed to
+/// [`ElligatorSwift::shared_secret`].
+///
+/// This distinction is important because the different parties compute different
+/// hashes of the shared secret.
 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub enum ElligatorSwiftParty {
     /// We are the initiator of the ECDH

src/lib.rs

@@ -194,9 +194,13 @@ use crate::ffi::CPtr;
 pub use crate::key::{InvalidParityValue, Keypair, Parity, PublicKey, SecretKey, XOnlyPublicKey};
 pub use crate::scalar::Scalar;
 
-/// Trait describing something that promises to be a 32-byte random number; in particular,
-/// it has negligible probability of being zero or overflowing the group order. Such objects
-/// may be converted to `Message`s without any error paths.
+/// Trait describing something that promises to be a 32-byte uniformly random number.
+///
+/// In particular, anything implementing this trait must have neglibile probability
+/// of being zero, overflowing the group order, or equalling any specific value.
+///
+/// Since version 0.29 this has been deprecated; users should instead implement
+/// `Into<Message>` for types that satisfy these properties.
 #[deprecated(
     since = "0.29.0",
     note = "Please see v0.29.0 rust-secp256k1/CHANGELOG.md for suggestion"