milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Change rustdoc heading level of references 

`Bitcoin Core References` used H3 `###` in rustdocs, and one occurrence
had another `References` heading above it.

Change them to be H1 `#` like other headings.

Remove the redundant `References` heading.  NB. there are no other
occurrences of `# References` in this crate.
This commit is contained in:
Jamil Lambert 2025-04-22 12:55:48 +01:00
parent f22e997587
commit 6325a7cdea
No known key found for this signature in database
GPG Key ID: 7F574053F8F17A64
3 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
primitives/src/block.rs
View File

@ -47,7 +47,7 @@ pub trait Validation: sealed::Validation + Sync + Send + Sized + Unpin {
/// ///
/// [wiki-block]: https://en.bitcoin.it/wiki/Block /// [wiki-block]: https://en.bitcoin.it/wiki/Block
/// ///
/// ### Bitcoin Core References /// # Bitcoin Core References
/// ///
/// * [CBlock definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/block.h#L62) /// * [CBlock definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/block.h#L62)
#[cfg(feature = "alloc")] #[cfg(feature = "alloc")]
@ -167,7 +167,7 @@ mod sealed {
/// ///
/// [Merkle tree]: https://en.wikipedia.org/wiki/Merkle_tree /// [Merkle tree]: https://en.wikipedia.org/wiki/Merkle_tree
/// ///
/// ### Bitcoin Core References /// # Bitcoin Core References
/// ///
/// * [CBlockHeader definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/block.h#L20) /// * [CBlockHeader definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/block.h#L20)
#[derive(Copy, PartialEq, Eq, Clone, PartialOrd, Ord, Hash)] #[derive(Copy, PartialEq, Eq, Clone, PartialOrd, Ord, Hash)]

5
primitives/src/script/borrowed.rs
View File

@ -49,10 +49,7 @@ internals::transparent_newtype! {
/// The type is `#[repr(transparent)]` for internal purposes only! /// The type is `#[repr(transparent)]` for internal purposes only!
/// No consumer crate may rely on the representation of the struct! /// No consumer crate may rely on the representation of the struct!
/// ///
/// ## References /// # Bitcoin Core References
///
///
/// ### Bitcoin Core References
/// ///
/// * [CScript definition](https://github.com/bitcoin/bitcoin/blob/d492dc1cdaabdc52b0766bf4cba4bd73178325d0/src/script/script.h#L410) /// * [CScript definition](https://github.com/bitcoin/bitcoin/blob/d492dc1cdaabdc52b0766bf4cba4bd73178325d0/src/script/script.h#L410)
/// ///

8
primitives/src/transaction.rs
View File

@ -48,7 +48,7 @@ use crate::witness::Witness;
/// ///
/// [wiki-transaction]: https://en.bitcoin.it/wiki/Transaction /// [wiki-transaction]: https://en.bitcoin.it/wiki/Transaction
/// ///
/// ### Bitcoin Core References /// # Bitcoin Core References
/// ///
/// * [CTtransaction definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L279) /// * [CTtransaction definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L279)
/// ///
@ -310,7 +310,7 @@ fn hash_transaction(tx: &Transaction, uses_segwit_serialization: bool) -> sha256
/// that it spends and set of scripts that satisfy its spending /// that it spends and set of scripts that satisfy its spending
/// conditions. /// conditions.
/// ///
/// ### Bitcoin Core References /// # Bitcoin Core References
/// ///
/// * [CTxIn definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L65) /// * [CTxIn definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L65)
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)] #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
@ -354,7 +354,7 @@ impl TxIn {
/// ///
/// An output that is not yet spent by an input is called Unspent Transaction Output ("UTXO"). /// An output that is not yet spent by an input is called Unspent Transaction Output ("UTXO").
/// ///
/// ### Bitcoin Core References /// # Bitcoin Core References
/// ///
/// * [CTxOut definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L148) /// * [CTxOut definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L148)
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)] #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
@ -370,7 +370,7 @@ pub struct TxOut {
/// A reference to a transaction output. /// A reference to a transaction output.
/// ///
/// ### Bitcoin Core References /// # Bitcoin Core References
/// ///
/// * [COutPoint definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L26) /// * [COutPoint definition](https://github.com/bitcoin/bitcoin/blob/345457b542b6a980ccfbc868af0970a6f91d1b82/src/primitives/transaction.h#L26)
#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)] #[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]