src/docs/cargo_common_metadata.txt

   1 ### What it does
   2 Checks to see if all common metadata is defined in
   3 `Cargo.toml`. See: https://rust-lang-nursery.github.io/api-guidelines/documentation.html#cargotoml-includes-all-common-metadata-c-metadata
   4
   5 ### Why is this bad?
   6 It will be more difficult for users to discover the
   7 purpose of the crate, and key information related to it.
   8
   9 ### Example
  10 ```
  11 [package]
  12 name = "clippy"
  13 version = "0.0.212"
  14 repository = "https://github.com/rust-lang/rust-clippy"
  15 readme = "README.md"
  16 license = "MIT OR Apache-2.0"
  17 keywords = ["clippy", "lint", "plugin"]
  18 categories = ["development-tools", "development-tools::cargo-plugins"]
  19 ```
  20
  21 Should include a description field like:
  22
  23 ```
  24 [package]
  25 name = "clippy"
  26 version = "0.0.212"
  27 description = "A bunch of helpful lints to avoid common pitfalls in Rust"
  28 repository = "https://github.com/rust-lang/rust-clippy"
  29 readme = "README.md"
  30 license = "MIT OR Apache-2.0"
  31 keywords = ["clippy", "lint", "plugin"]
  32 categories = ["development-tools", "development-tools::cargo-plugins"]
  33 ```