What the developer wrote
Authored by Tobin C. Harding
Improve bip links
We decided (in #4859) to use markdown links with the link at the
bottom of the docs section.
PR #4881 closed this PR, this is a follow up to fix the links.
What changed, and why it matters
This commit only reformats documentation comments. It changes how web links to Bitcoin Improvement Proposals (BIPs) are written in source-code documentation, moving the actual URL to the bottom of the doc block rather than embedding it inline. No program logic, math, cryptography, or transaction handling code is modified.
No security action needed. This is a cosmetic documentation cleanup and can be treated as routine maintenance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is a pure documentation style change in two Rust files. Inline Markdown reference-style links are replaced with named reference links whose targets are declared at the end of the doc comment. The linked URLs remain the same (or switch from a pinned commit to master for one BIP-0341 link). No executable code, signatures, hashes, serialization, or API behavior changes.
Changed components
bitcoin/src/crypto/sighash.rs (doc comments only)bitcoin/src/taproot/mod.rs (doc comments only)Inspect captured patch +8 / −6
diff --git a/bitcoin/src/crypto/sighash.rs b/bitcoin/src/crypto/sighash.rs
index 5908cb7c..affa8a2c 100644
--- a/bitcoin/src/crypto/sighash.rs
+++ b/bitcoin/src/crypto/sighash.rs
@@ -3,13 +3,14 @@
//! Signature hash implementation (used in transaction signing).
//!
//! Efficient implementation of the algorithm to compute the message to be signed according to
-//! [BIP-0341](https://github.com/bitcoin/bips/blob/150ab6f5c3aca9da05fccc5b435e9667853407f4/bip-0341.mediawiki),
-//! [BIP-0143](https://github.com/bitcoin/bips/blob/99701f68a88ce33b2d0838eb84e115cef505b4c2/bip-0143.mediawiki)
-//! and legacy (before BIP-0143).
+//! [BIP-0341], [BIP-0143] and legacy (before BIP-0143).
//!
//! Computing signature hashes is required to sign a transaction and this module is designed to
//! handle its complexity efficiently. Computing these hashes is as simple as creating
//! [`SighashCache`] and calling its methods.
+//!
+//! [BIP-0341]: <https://github.com/bitcoin/bips/blob/150ab6f5c3aca9da05fccc5b435e9667853407f4/bip-0341.mediawiki>
+//! [BIP-0143]: <https://github.com/bitcoin/bips/blob/99701f68a88ce33b2d0838eb84e115cef505b4c2/bip-0143.mediawiki>
use core::convert::Infallible;
use core::{fmt, str};
diff --git a/bitcoin/src/taproot/mod.rs b/bitcoin/src/taproot/mod.rs
index 52b854f2..fd75559c 100644
--- a/bitcoin/src/taproot/mod.rs
+++ b/bitcoin/src/taproot/mod.rs
@@ -221,12 +221,13 @@ type ScriptMerkleProofMap = BTreeMap<(TapScriptBuf, LeafVersion), BTreeSet<Tapro
/// control block.
///
/// If one or more of the spending conditions consist of just a single key (after aggregation), the
-/// most likely key should be made the internal key.
-/// See [BIP-0341](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki) for more details on
-/// choosing internal keys for a Taproot application.
+/// most likely key should be made the internal key. See [BIP-0341] for more details on choosing
+/// internal keys for a Taproot application.
///
/// Note: This library currently does not support
/// [annex](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki#cite_note-5).
+///
+/// [BIP-0341]: <https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki>
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct TaprootSpendInfo {
/// The BIP-0341 internal key.
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.