milksad
/
rust-secp256k1-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

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
This commit is contained in:
Tobin Harding 2022-01-13 16:45:05 +11:00
parent da3c24c56e
commit 4c4268f1ad
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib.rs
View File

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