Skip to content
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.

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

Add tooling to document lints #14025

Merged
merged 2 commits into from
Jun 7, 2024
Merged

Conversation

Muscraft
Copy link
Member

@Muscraft Muscraft commented Jun 7, 2024

One thing the linting system has been missing is documentation. There is no list of all cargo's lints and their associated documentation, like clippy or rustc has. To resolve this problem, I wrote a very basic tool that gathers the doc comments for a Lint and copies them to a markdown file in the Cargo book. This solution is not perfect but it is a way to work towards a better overall experience.

@rustbot
Copy link
Collaborator

rustbot commented Jun 7, 2024

r? @weihanglo

rustbot has assigned @weihanglo.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added A-documenting-cargo-itself Area: Cargo's documentation A-infrastructure Area: infrastructure around the cargo repo, ci, releases, etc. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 7, 2024
src/cargo/util/lints.rs Outdated Show resolved Hide resolved
src/cargo/util/lints.rs Outdated Show resolved Hide resolved
src/cargo/util/lints.rs Outdated Show resolved Hide resolved
@Muscraft Muscraft force-pushed the document-lints branch 2 times, most recently from cb95f86 to 7d7b7c2 Compare June 7, 2024 15:50
@epage
Copy link
Contributor

epage commented Jun 7, 2024

@bors r+

@bors
Copy link
Contributor

bors commented Jun 7, 2024

📌 Commit 7d7b7c2 has been approved by epage

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 7, 2024
@bors
Copy link
Contributor

bors commented Jun 7, 2024

⌛ Testing commit 7d7b7c2 with merge e8e50d0...

@bors
Copy link
Contributor

bors commented Jun 7, 2024

☀️ Test successful - checks-actions
Approved by: epage
Pushing e8e50d0 to master...

1 similar comment
@bors
Copy link
Contributor

bors commented Jun 7, 2024

☀️ Test successful - checks-actions
Approved by: epage
Pushing e8e50d0 to master...

@bors bors merged commit e8e50d0 into rust-lang:master Jun 7, 2024
24 checks passed
@bors
Copy link
Contributor

bors commented Jun 7, 2024

👀 Test was successful, but fast-forwarding failed: 422 Changes must be made through a pull request.

@Muscraft Muscraft deleted the document-lints branch June 7, 2024 17:13
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 8, 2024
Update cargo

8 commits in 34a6a87d8a2330d8c9d578f927489689328a652d..b1feb75d062444e2cee8b3d2aaa95309d65e9ccd
2024-06-04 15:31:01 +0000 to 2024-06-07 20:16:17 +0000
- Keep lints updated (rust-lang/cargo#14030)
- test(lints): Ensure unused optional dep fires for shadowed dep (rust-lang/cargo#14028)
- Add `cargo update --breaking` (rust-lang/cargo#13979)
- Add tooling to document lints (rust-lang/cargo#14025)
- Rename --out-dir to --artifact-dir (rust-lang/cargo#13809)
- fix(lints): Add unknown_lints to lints list (rust-lang/cargo#14024)
- docs(contrib): Suggest atomic commits with separate test commits (rust-lang/cargo#14014)
- test(semver): track the behavior of `--precise <prerelease>` (rust-lang/cargo#14013)

r? ghost
@rustbot rustbot added this to the 1.81.0 milestone Jun 8, 2024
flip1995 pushed a commit to flip1995/rust-clippy that referenced this pull request Jun 28, 2024
Update cargo

8 commits in 34a6a87d8a2330d8c9d578f927489689328a652d..b1feb75d062444e2cee8b3d2aaa95309d65e9ccd
2024-06-04 15:31:01 +0000 to 2024-06-07 20:16:17 +0000
- Keep lints updated (rust-lang/cargo#14030)
- test(lints): Ensure unused optional dep fires for shadowed dep (rust-lang/cargo#14028)
- Add `cargo update --breaking` (rust-lang/cargo#13979)
- Add tooling to document lints (rust-lang/cargo#14025)
- Rename --out-dir to --artifact-dir (rust-lang/cargo#13809)
- fix(lints): Add unknown_lints to lints list (rust-lang/cargo#14024)
- docs(contrib): Suggest atomic commits with separate test commits (rust-lang/cargo#14014)
- test(semver): track the behavior of `--precise <prerelease>` (rust-lang/cargo#14013)

r? ghost
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation A-infrastructure Area: infrastructure around the cargo repo, ci, releases, etc. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants