Skip to content

Commit 4c4268f

Browse files
committed
Improve docs on method generate_keypair
Improve method docs by doing: - Remove 'batch' comment - Remove mention of required features, docs already show this - Use links to types as well as ticks
1 parent da3c24c commit 4c4268f

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

src/lib.rs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -434,10 +434,8 @@ impl<C: Context> Secp256k1<C> {
434434
}
435435

436436
impl<C: Signing> Secp256k1<C> {
437-
/// Generates a random keypair. Convenience function for `key::SecretKey::new`
438-
/// and `key::PublicKey::from_secret_key`; call those functions directly for
439-
/// batch key generation. Requires a signing-capable context. Requires compilation
440-
/// with the "rand" feature.
437+
/// Generates a random keypair. Convenience function for [`SecretKey::new`] and
438+
/// [`PublicKey::from_secret_key`].
441439
#[inline]
442440
#[cfg(any(test, feature = "rand"))]
443441
#[cfg_attr(docsrs, doc(cfg(feature = "rand")))]

0 commit comments

Comments
 (0)