Skip to content

RFC: Add a semantically non-blocking lint level #3730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
epage wants to merge 35 commits into
base: master
Choose a base branch
from
Open

RFC: Add a semantically non-blocking lint level #3730

Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
95ca8a9
Add skeleton
epage Nov 16, 2024
a8d4932
feat: Initial draft
epage Nov 19, 2024
ee5c90e
fix: Rename the file for RFC#
epage Nov 19, 2024
066712c
fix: Update body with RFC#
epage Nov 19, 2024
91be5d2
fix: Be less prescriptive on rendering
epage Nov 19, 2024
1bc7f95
feat: Add nit as an option
epage Nov 19, 2024
883fb82
fix: Clarify the nit concern
epage Nov 19, 2024
b7093ce
feat: Add 'mention' as an option
epage Nov 19, 2024
6445281
fix: Cover warning fatigue
epage Nov 19, 2024
56876e2
fix: Link to the original internals thread
epage Nov 19, 2024
f82b8ca
fix: Avoid broken windows
epage Nov 19, 2024
fb61bb2
feat: Add Github prior art
epage Nov 19, 2024
9e3c40a
feat: Start talking to how CI can be done
epage Nov 19, 2024
a03f5d2
feat(motivation): Talk to migrating allows to warns
epage Nov 19, 2024
5e30760
feat(future): Discuss first-party SARIF support
epage Nov 20, 2024
14faa69
feat(alt): Discuss pedantic
epage Nov 20, 2024
2410bb1
feat(ref): Discuss clippy
epage Nov 20, 2024
21f543a
feat(motivation): Call out the avoid-breaking-exported-api casee
epage Nov 21, 2024
d581438
feat(motivation): Cover soft-errors that block release
epage Nov 21, 2024
eaf0145
feat(rationale): Highlight the strengths of this solution
epage Nov 22, 2024
a9d8e56
fix(rationale): Call out that CARGO_BUILD_NITS=deny doesn't make sense
epage Nov 22, 2024
9f27926
fix(rationale): Call out LSP reporting benefit
epage Nov 22, 2024
bf52f75
feat(ref): Discuss cargo-fix behavior
epage Nov 30, 2024
d7b6a82
fix: Clear up language
epage Feb 5, 2025
764841d
fix: Add nitpick as an alternative
epage Feb 5, 2025
24c9506
fix: Call out rust-analyzer / LSP behavior
epage Feb 5, 2025
3320270
fix: Add missing period
epage Feb 5, 2025
6ee328c
fix: Switch from two leading spaces to one
epage Feb 5, 2025
bd812a2
fix: Grammatical correction
epage Feb 5, 2025
8be68a2
fix: Improve a sentence structure
epage Feb 5, 2025
3c7b59c
fix: Spelling
epage Feb 5, 2025
8484743
fix: Remove redundancy between config drawback and unresolved question
epage Feb 5, 2025
fdd4021
fix(drawback): Mention verbosity, cli control
epage Feb 5, 2025
852f061
fix(question): Carry over the config table question from CARGO_BUILD_…
epage Feb 5, 2025
1d7463f
fix(alt): Cover 'show nits if nothing else'
epage Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: Cover warning fatigue
  • Loading branch information
@epage
epage committed Nov 19, 2024
commit 644528155be4090cd88b9659efbc44a491bd4b17
4 changes: 4 additions & 0 deletions text/3730-nit-lint-level.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ this new lint level.
By its name and literal usage, the `warn` level is non-blocking.
However, most projects treat `warn` as a soft-error.
It doesn't block for local development but CI blocks it from being merged.

@BenjaminBrienen BenjaminBrienen Nov 23, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It doesn't block for local development but CI blocks it from being merged.
It doesn't block for local development, but CI blocks it from being merged.

This is an attempt to balance final correctness with rapid prototyping.
Requiring "warnings clean" code also avoids warnings fatigue where warnings

@BenjaminBrienen BenjaminBrienen Nov 23, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Requiring "warnings clean" code also avoids warnings fatigue where warnings
Requiring "warnings-clean" code also avoids warnings fatigue where warnings

make it hard to see "relevant' compiler output and
act as proverbial [broken windows](https://en.wikipedia.org/wiki/Broken_windows_theory).
Comment thread
epage marked this conversation as resolved.
Outdated
This convention is not new with the Rust community; many C++ projects have take
this approach before Rust came to be with "warnings clean" being a goal for

@BenjaminBrienen BenjaminBrienen Nov 23, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
this approach before Rust came to be with "warnings clean" being a goal for
this approach before Rust came to be with "warnings-clean" being a goal for

correctness.
Comment thread
joshtriplett marked this conversation as resolved.
Expand Down