rust-bitcoin / rust-bitcoin / 11222254760

83%

push

github

Merge rust-bitcoin/rust-bitcoin#3440: Add stricter rustdoc requirement to `CONTRIBUTING.md`

<a class=hub.com/rust-bitcoin/rust-bitcoin/commit/<a class="double-link" href="https://git"><a class=hub.com/rust-bitcoin/rust-bitcoin/commit/2d32e74542b927d583a4f14eae3cb150e993d80a">2d32e7454 Add stricter rustdoc requirement (Jamil Lambert, PhD)

Pull request description:

  Example code in rustdocs should be error free and not produce warnings when copy pasted.

  The section on rustdocs has been expanded to clarify that example code should compile without any errors or warnings with the stricter `lint` that has been added to the justfile.

  All existing example code in the rustdocs has now been fixed and there are no warnings from unused code, the justfile has been updated to have a stricter `lint` which produces warnings and this addition to `CONTRIBUTING.md` has clarified that new additions should follow these rules.

  Close #3362

ACKs for top commit:
  apoelstra:
    ACK 2d32e74542b927d583a4f14eae3cb150e993d80a successfully ran local tests
  tcharding:
    ACK 2d32e74542b927d583a4f14eae3cb150e993d80a

Tree-SHA512: 751475b4bc330e6334fdf1dae9f8a711e2b

19095 of 23113 relevant lines covered (82.62%)

18877.37 hits per line