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

Improve rustdocs on schnorr module 

Improve the docs by doing:

- Use [`Foo`] for types
- Use third person tense
- Add trailing periods
This commit is contained in:
Tobin Harding 2021-12-10 11:42:43 +11:00
parent a6d3514f2b
commit b5bf6d7319
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/util/schnorr.rs
View File

@ -44,7 +44,7 @@ pub trait TapTweak {
/// The tweaked key and its parity. /// The tweaked key and its parity.
fn tap_tweak<C: Verification>(self, secp: &Secp256k1<C>, merkle_root: Option<TapBranchHash>) -> (TweakedPublicKey, bool); fn tap_tweak<C: Verification>(self, secp: &Secp256k1<C>, merkle_root: Option<TapBranchHash>) -> (TweakedPublicKey, bool);
/// Directly convert an UntweakedPublicKey to a TweakedPublicKey /// Directly converts an [`UntweakedPublicKey`] to a [`TweakedPublicKey`]
/// ///
/// This method is dangerous and can lead to loss of funds if used incorrectly. /// This method is dangerous and can lead to loss of funds if used incorrectly.
/// Specifically, in multi-party protocols a peer can provide a value that allows them to steal. /// Specifically, in multi-party protocols a peer can provide a value that allows them to steal.
@ -74,12 +74,12 @@ impl TweakedPublicKey {
TweakedPublicKey(key) TweakedPublicKey(key)
} }
/// Returns the underlying public key /// Returns the underlying public key.
pub fn into_inner(self) -> PublicKey { pub fn into_inner(self) -> PublicKey {
self.0 self.0
} }
/// Returns a reference to underlying public key /// Returns a reference to underlying public key.
pub fn as_inner(&self) -> &PublicKey { pub fn as_inner(&self) -> &PublicKey {
&self.0 &self.0
} }