Remove docs on deprecated is_null function

Our `define_extension_trait` macro cannot handle examples in rustdocs,
since these docs are on the deprecated `OutPoint::is_null` function just
remove them.
This commit is contained in:
Tobin C. Harding 2024-09-27 11:38:19 +10:00
parent 97b20a2316
commit 7e5bd5048d
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 0 additions and 13 deletions

View File

@ -111,19 +111,6 @@ impl OutPoint {
pub fn null() -> OutPoint { Self::COINBASE_PREVOUT }
/// Checks if an `OutPoint` is "null".
///
/// # Examples
///
/// ```rust
/// use bitcoin::constants::genesis_block;
/// use bitcoin::params;
///
/// let block = genesis_block(&params::MAINNET);
/// let tx = &block.txdata[0];
///
/// // Coinbase transactions don't have any previous output.
/// assert!(tx.input[0].previous_output.is_null());
/// ```
#[inline]
#[deprecated(since = "TBD", note = "use outpoint == OutPoint::COINBASE_PREVOUT instead")]
pub fn is_null(&self) -> bool { *self == OutPoint::null() }