Merge rust-bitcoin/rust-bitcoin#3389: Ignore doc example that has a compile error

46386337b0 Ignore doc compile error (Jamil Lambert, PhD)

Pull request description:

  With the stricter doc tests required to pick up unused imports etc. the code under the `compile_fail` tag also creates an Error.

  Changed `compile_fail` to `ignore` to remove the Error.

ACKs for top commit:
  tcharding:
    ACK 46386337b0
  apoelstra:
    ACK 46386337b0 successfully ran local tests

Tree-SHA512: 67513464dede8d4bd9f9fa4363ccb58e774b180f331edc4486290784f61e931195225765768030d2709f618ba4afe17d034d4bbc4d649a02e7a34b47b48bd297
This commit is contained in:
merge-script 2024-09-20 14:50:48 +00:00
commit f804e0027b
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 2 additions and 1 deletions

View File

@ -1127,7 +1127,8 @@ impl<R: BorrowMut<Transaction>> SighashCache<R> {
///
/// # Examples
///
/// ```compile_fail
/// ```ignore
/// # // Example is an incomplete section of code that does not compile by itself
/// let mut sighasher = SighashCache::new(&mut tx_to_sign);
/// let sighash = sighasher.p2wpkh_signature_hash(input_index, &utxo.script_pubkey, amount, sighash_type)?;
///