Fix FAILPOINTS variable name in docs, and lints #76
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sourcefrog
force-pushed
the
doc-var-name
branch
from
d41d601 to
ebf6735
Compare
|
I don't know if there is any way to satisfy both stable and nightly Clippy here without allowing unknown lints, which seems like it might allow the old name to hang around, and it seems tangential to the core typo fix. Anyhow, let me know what you want, or if you're open to merging this. |
BusyJay
reviewed
Feb 26, 2024
|
Rest LGTM |
|
Thanks, please take another look. |
|
Please sign off your last commit. |
Signed-off-by: Martin Pool <[email protected]>
Signed-off-by: Martin Pool <[email protected]>
cargo doesn't run #[test] inside doctests; see https://rust-lang.github.io/rust-clippy/master/index.html#/test_attr_in_doctest Signed-off-by: Martin Pool <[email protected]>
Signed-off-by: Martin Pool <[email protected]>
sourcefrog
force-pushed
the
doc-var-name
branch
from
c782eb3 to
b0e8a05
Compare
done |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
name: Fix env var name in docs
about: A bug squashed.
Related bugs:
n/a
Description of problem:
When reading the docs I was briefly confused what the correct variable name was.1
Description of solution:
Fix the docs to match the code.
Also, since rustc warns that unit tests inside docests are not run, mark it as
norunfor clarity and to address a warning.Checklist:
The CI will check all of these, but you'll need to have done them:
cargo fmt -- --checkpasses.cargo +nightly clippyhas no warnings.cargo testpasses.