Skip to content

Commit

Permalink
Add stricter rustdoc requirement
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jamillambert committed Oct 3, 2024
1 parent e8a3c1f commit 2d32e74
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>.

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 2d32e74

Please sign in to comment.