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

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

2d32e74542 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 2d32e74542 successfully ran local tests
  tcharding:
    ACK 2d32e74542

Tree-SHA512: 751475b4b8e9cfa35dba9f9708bb38e099387c24c330e6334fe97170273cfa63e4eb74fad51949d2fdf1dae9fe0dd56b85c043e6d6d4bb450eca35418a711e2b
This commit is contained in:
merge-script 2024-10-07 19:06:26 +00:00
parent 31f1a12aaf 2d32e74542
commit 6892b62fd2
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -110,7 +110,8 @@ Prerequisites that a PR must satisfy for merging into the `master` branch:
commits, or, more preferably, as separate commits, so that it's easy to
reorder them during review and check that the new tests fail without the new
code);
* contain all inline docs for newly introduced API and pass doc tests;
* contain all inline docs for newly introduced API and pass doc tests including
running `just lint` without any errors or warnings;
* be based on the recent `master` tip from the original repository at
<https://github.com/rust-bitcoin/rust-bitcoin>.
@ -428,6 +429,8 @@ Generally we prefer to have non-panicking APIs but it is impractical in some cas
sure, feel free to ask. If we determine panicking is more practical it must be documented. Internal
panics that could theoretically occur because of bugs in our code must not be documented.
Example code within the rustdocs should compile and lint with `just lint` without any errors or
warnings.
#### Derives