Skip to content

Commit

Permalink
clippy: fix indentation in documentation
Browse files Browse the repository at this point in the history
We had several accidental list-item continuation in our docs. Add
newlines to break them up.
  • Loading branch information
apoelstra committed Jun 19, 2024
1 parent 4ab1b77 commit 172e36b
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
1 change: 1 addition & 0 deletions examples/pset_blind_coinjoin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
//! 6. A signs it's input
//! 7. A finalizes the pset
//! 8. A extracts and broadcasts the transaction
//!
//! During the entire interaction, the output blinding factors for A and B are not
//! shared with each other.
extern crate bitcoin;
Expand Down
7 changes: 4 additions & 3 deletions src/opcodes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -459,10 +459,10 @@ pub mod all {
pub const OP_INSPECTINPUTVALUE: All = All {code: 0xc9};
/// Pop a CScriptNum input index idx and push the following depending the type of scriptPubkey:
/// - If the scriptPubKey is not a native segwit program, push a single sha256
/// hash of the scriptPubKey on stack top. Next, push a CScriptNum(-1) to
/// indicate a non-native segwit scriptPubKey.
/// hash of the scriptPubKey on stack top. Next, push a CScriptNum(-1) to
/// indicate a non-native segwit scriptPubKey.
/// - If the scriptPubKey is a native segwit program, push the witness program(2-40)
/// followed by a push for segwit version(0-1).
/// followed by a push for segwit version(0-1).
pub const OP_INSPECTINPUTSCRIPTPUBKEY: All = All {code: 0xca};
/// Pop a CScriptNum input index idx and push the nSequence(4) as little-endian number.
pub const OP_INSPECTINPUTSEQUENCE: All = All {code: 0xcb};
Expand Down Expand Up @@ -544,6 +544,7 @@ pub mod all {
/// 1) a 32 byte big endian, unsigned scalar k.
/// 2) Compressed EC point P, and
/// 3) compressed EC point Q.
///
/// Abort if P, Q is invalid or k is not 32 bytes and outside of secp256k1 curve order.
/// Abort if Q != k*P.
pub const OP_ECMULSCALARVERIFY: All = All {code: 0xe3};
Expand Down
1 change: 1 addition & 0 deletions src/schnorr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ impl TapTweak for UntweakedKeypair {
/// * p is the internal private key
/// * H is the hash function
/// * c is the commitment data
///
/// The public key is generated from a private key by multiplying with generator point, Q = qG.
///
/// # Returns
Expand Down
2 changes: 1 addition & 1 deletion src/taproot.rs
Original file line number Diff line number Diff line change
Expand Up @@ -621,7 +621,7 @@ impl ControlBlock {
///
/// # Errors:
/// - If the control block size is not of the form 33 + 32m where
/// 0 <= m <= 128, InvalidControlBlock is returned
/// 0 <= m <= 128, InvalidControlBlock is returned
pub fn from_slice(sl: &[u8]) -> Result<ControlBlock, TaprootError> {
if sl.len() < TAPROOT_CONTROL_BASE_SIZE
|| (sl.len() - TAPROOT_CONTROL_BASE_SIZE) % TAPROOT_CONTROL_NODE_SIZE != 0
Expand Down

0 comments on commit 172e36b

Please sign in to comment.