Skip to content

Commit 4c9bab9

Browse files
committed
Remove explicit mention of feature requirements
We are using `cfg_attr` to instruct the rustdocs build system to highlight feature requirements for functions, there is no need to explicitly mention feature requirements in the text.
1 parent 806eaca commit 4c9bab9

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

src/schnorr.rs

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,6 @@ impl<C: Signing> Secp256k1<C> {
128128

129129
/// Create a schnorr signature internally using the ThreadRng random number
130130
/// generator to generate the auxiliary random data.
131-
/// Requires compilation with "rand-std" feature.
132131
#[cfg(any(test, feature = "rand-std"))]
133132
#[cfg_attr(docsrs, doc(cfg(feature = "rand-std")))]
134133
#[deprecated(since = "0.21.0", note = "Use sign_schnorr instead.")]
@@ -138,7 +137,6 @@ impl<C: Signing> Secp256k1<C> {
138137

139138
/// Create a schnorr signature internally using the ThreadRng random number
140139
/// generator to generate the auxiliary random data.
141-
/// Requires compilation with "rand-std" feature.
142140
#[cfg(any(test, feature = "rand-std"))]
143141
#[cfg_attr(docsrs, doc(cfg(feature = "rand-std")))]
144142
pub fn sign_schnorr(&self, msg: &Message, keypair: &KeyPair) -> Signature {
@@ -191,8 +189,7 @@ impl<C: Signing> Secp256k1<C> {
191189
}
192190

193191
/// Create a schnorr signature using the given random number generator to
194-
/// generate the auxiliary random data. Requires compilation with "rand"
195-
/// feature.
192+
/// generate the auxiliary random data.
196193
#[cfg(any(test, feature = "rand"))]
197194
#[cfg_attr(docsrs, doc(cfg(feature = "rand")))]
198195
#[deprecated(since = "0.21.0", note = "Use sign_schnorr_with_rng instead.")]
@@ -206,8 +203,7 @@ impl<C: Signing> Secp256k1<C> {
206203
}
207204

208205
/// Create a schnorr signature using the given random number generator to
209-
/// generate the auxiliary random data. Requires compilation with "rand"
210-
/// feature.
206+
/// generate the auxiliary random data.
211207
#[cfg(any(test, feature = "rand"))]
212208
#[cfg_attr(docsrs, doc(cfg(feature = "rand")))]
213209
pub fn sign_schnorr_with_rng<R: Rng + CryptoRng>(
@@ -262,7 +258,7 @@ impl <C: Signing> Secp256k1<C> {
262258
/// Generates a random Schnorr `KeyPair` and its associated Schnorr `XOnlyPublicKey`.
263259
///
264260
/// Convenience function for [KeyPair::new] and [KeyPair::public_key].
265-
/// Requires a signing-capable context and requires compilation with the "rand" feature.
261+
/// Requires a signing-capable context.
266262
#[inline]
267263
#[cfg(any(test, feature = "rand"))]
268264
#[cfg_attr(docsrs, doc(cfg(feature = "rand")))]

0 commit comments

Comments
 (0)