From 1cfb6a20ff9a224c97f7b05490ccc8c58b76340d Mon Sep 17 00:00:00 2001 From: "Tobias V. Langhoff" Date: Wed, 17 Aug 2022 00:28:58 +0200 Subject: [PATCH] C-METADATA: Change `authors` field to optional See RFC 3052 --- src/documentation.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/documentation.md b/src/documentation.md index 63ce31f..c2cc801 100644 --- a/src/documentation.md +++ b/src/documentation.md @@ -183,17 +183,17 @@ all the things"]. The `[package]` section of `Cargo.toml` should include the following values: -- `authors` - `description` - `license` - `repository` - `keywords` - `categories` -In addition, there are two optional metadata fields: +In addition, there are three optional metadata fields: - `documentation` - `homepage` +- `authors` By default, *crates.io* links to documentation for the crate on [*docs.rs*]. The `documentation` metadata only needs to be set if the documentation is hosted @@ -207,6 +207,10 @@ crate other than the source repository or API documentation. Do not make `homepage` redundant with either the `documentation` or `repository` values. For example, serde sets `homepage` to *https://serde.rs*, a dedicated website. +The `authors` metadata only needs to be set if the crate uses the information +directly, for example in the help text of a command-line binary. Neither +*crates.io* nor *docs.rs* use this metadata field for authorship information. + ## Release notes document all significant changes (C-RELNOTES)