Skip to content

docs(contrib): Link out to rustc diagnostic style guide #16216

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

Merged
merged 1 commit into from
Nov 6, 2025
Merged

docs(contrib): Link out to rustc diagnostic style guide #16216

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion src/doc/contrib/src/implementation/console.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,17 @@ the [`JobQueue`] as it processes each message.
[`drop_print`]: https://github.com/rust-lang/cargo/blob/e4b65bdc80f2a293447f2f6a808fa7c84bf9a357/src/cargo/util/config/mod.rs#L1820-L1848
[`JobQueue`]: https://github.com/rust-lang/cargo/blob/master/src/cargo/core/compiler/job_queue/mod.rs

## Errors
## Diagnostics

See rustc's [Errors and lints] for:
- diagnostic structure
- hard diagnostics vs lints
- diagnostic style guide
- lint naming
- diagnostic levels
- suggestion style guide

### Errors

Cargo uses [`anyhow`] for managing errors. This makes it convenient to "chain"
errors together, so that Cargo can report how an error originated, and what it
Expand Down Expand Up @@ -56,3 +66,4 @@ Some guidelines for Cargo's output:
future to be more structured.

[`anyhow`]: https://docs.rs/anyhow
[Errors and lints]: https://rustc-dev-guide.rust-lang.org/diagnostics.html