rust-bitcoin / rust-bitcoin / 14647001331

83%

push

github

Merge rust-bitcoin/rust-bitcoin#4383: rustdocs: Make headings consistent

<a class=hub.com/rust-bitcoin/rust-bitcoin/commit/c4d9c1b9f8e59bf795812c42bd1eee68d97b9bbd">c4d9c1b9f<a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/04f706f6bd0125048989758337b2abe816686423"> Use a consistent rustdoc heading level of H1 `#` (Jamil Lambert)
<a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/6325a7cdea7cdf7025d6ba41af28a542ab6b51b1">6325a7cde</a><a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/04f706f6bd0125048989758337b2abe816686423"> Change rustdoc heading level of references (Jamil Lambert)
</a><a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/f22e9975872e1d23a2b5b7b036060a6f387a19ea">f22e99758</a><a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/04f706f6bd0125048989758337b2abe816686423"> Use parameters instead of arguments in rustdocs (Jamil Lambert)
</a><a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/e2c7be6d2f5e017a67ed919e9f75176ca539a339">e2c7be6d2</a> 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: c8cc77ccf0cd8ac61b258b8e51c2ece58a1

22613 of 26900 relevant lines covered (84.06%)

16562.78 hits per line