taproot_primitives: add missing docs backtics
What changed, and why it matters
This commit only fixes documentation formatting by adding Rustdoc backtick link syntax to comments. It changes no executable code, no APIs, and no behavior. There is no security relevance.
No security action needed. Treat as a normal documentation cleanup commit.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch updates three doc comments to use Rustdoc intra-doc link backticks ([...]) or code formatting backticks around type names and hash type identifiers. It affects only documentation strings in bitcoin/src/crypto/sighash.rs, hashes/tests/api.rs, and taproot_primitives/src/lib.rs. No logic, types, signatures, or test behavior is modified.
Changed components
bitcoin/src/crypto/sighash.rs (documentation only)hashes/tests/api.rs (documentation only)taproot_primitives/src/lib.rs (documentation only)Inspect captured patch +4 / −4
### bitcoin/src/crypto/sighash.rs
@@ -113,7 +113,7 @@ impl sha256t::Tag for TapSighashTag {
}
hash_newtype! {
- /// Taproot-tagged hash with tag \"TapSighash\".
+ /// Taproot-tagged hash with tag [`TapSighashTag`].
///
/// This hash type is used for computing Taproot signature hash.
pub struct TapSighash(sha256t::Hash<TapSighashTag>);
### hashes/tests/api.rs
@@ -35,7 +35,7 @@ sha256t_tag! {
struct Tag = raw(TEST_MIDSTATE, 64);
}
hash_newtype! {
- /// A concrete SHA256t hash type so we don't have to use generics.
+ /// A concrete `SHA256t` hash type so we don't have to use generics.
#[derive(Debug)]
struct TaggedHash(sha256t::Hash<Tag>);
}
### taproot_primitives/src/lib.rs
@@ -76,7 +76,7 @@ impl sha256t::Tag for TapLeafTag {
}
hash_newtype! {
- /// Taproot-tagged hash with tag \"TapLeaf\".
+ /// Taproot-tagged hash with tag [`TapLeafTag`].
///
/// This is used for computing tapscript script spend hash.
pub struct TapLeafHash(sha256t::Hash<TapLeafTag>);
@@ -152,7 +152,7 @@ impl sha256t::Tag for TapTweakTag {
}
hash_newtype! {
- /// Taproot-tagged hash with tag \"TapTweak\".
+ /// Taproot-tagged hash with tag [`TapTweakTag`].
///
/// This hash type is used while computing the tweaked public key.
pub struct TapTweakHash(sha256t::Hash<TapTweakTag>);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.