From cd7a6b316b9adf4c16c1816e892f48e77776e784 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Thu, 10 Nov 2022 10:40:49 +1100 Subject: [PATCH] Fix incorrect method call We have the following method on `SecretKey` ``` pub fn sign_ecdsa(&self, msg: Message) -> ecdsa::Signature { SECP256K1.sign_ecdsa(&msg, self) } ``` But we have a method call in rustdocs ``` //! let (secret_key, public_key) = generate_keypair(&mut thread_rng()); //! let message = Message::from_hashed_data::("Hello World!".as_bytes()); //! //! let sig = secret_key.sign_ecdsa(&message, &secret_key); ``` This is incorrect and is currently not running because the feature guard is incorrectly spelled, it contains the word "features" instead of "feature". --- src/lib.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index aff0cdf..934c8bb 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -58,7 +58,7 @@ //! If the "global-context" feature is enabled you have access to an alternate API. //! //! ```rust -//! # #[cfg(all(feature="global-context", feature = "std", feature="rand-std", features = "bitcoin-hashes-std"))] { +//! # #[cfg(all(feature = "global-context", feature = "std", feature = "rand-std", feature = "bitcoin-hashes-std"))] { //! use secp256k1::rand::thread_rng; //! use secp256k1::{generate_keypair, Message}; //! use secp256k1::hashes::sha256; @@ -66,7 +66,7 @@ //! let (secret_key, public_key) = generate_keypair(&mut thread_rng()); //! let message = Message::from_hashed_data::("Hello World!".as_bytes()); //! -//! let sig = secret_key.sign_ecdsa(&message, &secret_key); +//! let sig = secret_key.sign_ecdsa(message); //! assert!(sig.verify(&message, &public_key).is_ok()); //! # } //! ```