M0009 package-description¶
Rule: Every crate has a description in its Cargo.toml.
| Code | M0009 (stable, never reused) |
| Id | package-description |
| Category | manifest |
| Source | spirit_level |
| Fix | by hand |
Level per tier¶
| Tier | Level | Reason |
|---|---|---|
| small | warn |
the crate's one-line description is written once, in Cargo.toml; tables and READMEs are made from it |
| small-workspace | warn |
the crate's one-line description is written once, in Cargo.toml; tables and READMEs are made from it |
| medium | warn |
the crate's one-line description is written once, in Cargo.toml; tables and READMEs are made from it |
| big | deny |
the generated crate table and READMEs are made from it |
| ai | off | |
| embedded | off | |
| ui | off | |
| egui | off | |
| units-strict | off | |
| units-paranoid | off |
Why¶
A crate's one-line description is written once, in its Cargo.toml. The generated crate table, the README of a big workspace and cargo metadata consumers all read it from there, so a crate without one shows up as a blank row everywhere.
Example¶
[package]
name = "foo_core"
description = "foo's domain types: ids, units and the error enum, no I/O"
How to fix¶
Add description under [package]: one line saying what the crate is, not how it is built.
Configure¶
Allow one finding in the code with // spirit-level: allow(package-description) <reason> (waivers); the code works there too, as in [lints.M0009].