From da0795e590a64b2591a00c68943e1c0f1a688d65 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Thu, 19 Sep 2024 14:40:10 +1000 Subject: [PATCH] primitives: Use doc links for OutPoint Now that `OutPoint` is in `primitives` we can use a rustdoc link. While we are at it link from the error type docs too. Close: #3347 --- primitives/src/transaction.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/primitives/src/transaction.rs b/primitives/src/transaction.rs index b0c62d6e5..9b970eddc 100644 --- a/primitives/src/transaction.rs +++ b/primitives/src/transaction.rs @@ -89,7 +89,7 @@ fn parse_vout(s: &str) -> Result { parse::int(s).map_err(ParseOutPointError::Vout) } -/// An error in parsing an OutPoint. +/// An error in parsing an [`OutPoint`]. #[derive(Debug, Clone, PartialEq, Eq)] #[non_exhaustive] #[cfg(feature = "alloc")] @@ -156,7 +156,7 @@ impl Txid { /// The `Txid` used in a coinbase prevout. /// /// This is used as the "txid" of the dummy input of a coinbase transaction. This is not a real - /// TXID and should not be used in any other contexts. See `OutPoint::COINBASE_PREVOUT`. + /// TXID and should not be used in any other contexts. See [`OutPoint::COINBASE_PREVOUT`]. pub const COINBASE_PREVOUT: Self = Self::from_byte_array([0; 32]); }