tikv / fail-rs

Fail points for rust
Apache License 2.0
332 stars 39 forks source link

Fix FAILPOINTS variable name in docs, and lints #76

Closed sourcefrog closed 6 months ago

sourcefrog commented 8 months ago

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 norun for clarity and to address a warning.

Checklist: The CI will check all of these, but you'll need to have done them:

sourcefrog commented 8 months ago

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 commented 6 months ago

Rest LGTM

sourcefrog commented 6 months ago

Thanks, please take another look.

BusyJay commented 6 months ago

Please sign off your last commit.

sourcefrog commented 6 months ago

Please sign off your last commit.

done