milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-bitcoin-unsafe-fast/primitives/src
History
merge-script 04f706f6bd
Merge rust-bitcoin/rust-bitcoin#4383: rustdocs: Make headings consistent 
c4d9c1b9f8 Use a consistent rustdoc heading level of H1 `#` (Jamil Lambert)
6325a7cdea Change rustdoc heading level of references (Jamil Lambert)
f22e997587 Use parameters instead of arguments in rustdocs (Jamil Lambert)
e2c7be6d2f Fix typo (Jamil Lambert)

Pull request description:

  In the rustdocs both `# Parameters` and `# Arguments` are used to mean the same thing.  In a previous PR #2792 it was decided to go with Parameters everywhere.  Since then there have been a few additions of "Arguments" into the rustdocs.

  There is also a mix in the usage of `#`, `##` or `###` for headings.  Noticed here https://github.com/rust-bitcoin/rust-bitcoin/pull/2792#issuecomment-2125775974.

   - Fix a typo found when looking into this.

   - Change all occurances to use `# Parameters` in rustdocs.

   - Change all heading levels to H1 `#`

   - Change all subheading levels to H3 `###` to make the small difference in the rendered font size noticable

  Closes #4380

ACKs for top commit:
  apoelstra:
    ACK c4d9c1b9f8e59bf795812c42bd1eee68d97b9bbd; successfully ran local tests

Tree-SHA512: c8cc77ccf7e2003dd2dd1d309268624576e3bf390cd8ac61b0a7bb1141ca05377c83627576b0b7ff258b8e51c2d255097a4363fbdd1b368db7d32ac32ece58a1
 		2025-04-24 16:44:17 +00:00
..
locktime Use a consistent rustdoc heading level of H1 `#` 2025-04-22 13:06:32 +01:00
script Use a consistent rustdoc heading level of H1 `#` 2025-04-22 13:06:32 +01:00
block.rs Merge rust-bitcoin/rust-bitcoin#4383: rustdocs: Make headings consistent 2025-04-24 16:44:17 +00:00
lib.rs Merge rust-bitcoin/rust-bitcoin#4219: Rename then new `Timestamp` type 2025-03-13 15:13:31 +00:00
merkle_tree.rs primitives: Make hex optional 2025-04-11 10:55:34 +10:00
opcodes.rs 2025-03-16 automated rustfmt nightly 2025-03-16 01:25:25 +00:00
pow.rs primitives: Enable pedantic lints 2025-03-06 10:58:17 +11:00
sequence.rs Use a consistent rustdoc heading level of H1 `#` 2025-04-22 13:06:32 +01:00
taproot.rs Move taproot back to bitcoin crate 2025-02-26 15:45:49 +11:00
transaction.rs Merge rust-bitcoin/rust-bitcoin#4383: rustdocs: Make headings consistent 2025-04-24 16:44:17 +00:00
witness.rs Merge rust-bitcoin/rust-bitcoin#4382: Cleanup witness module 2025-04-24 14:51:02 +00:00