Skip to content

docs: describe why package.authors is deprecated #17332

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

Draft
AlexTMjugador wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −1
Draft

docs: describe why package.authors is deprecated #17332

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
9 changes: 8 additions & 1 deletion doc/book/src/reference/manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,12 @@ This field is optional and defaults to `0.0.0`. The field is required for publi

### The `authors` field

> **Warning**: This field is deprecated
> **Warning**: This field is deprecated and may be considered for removal in
> the future. The definition of "author" has subjective and context-dependent
> nuances, listing significant contributors does not scale to projects with
> many contributors, and the immutability of published releases required by
> registries such as crates.io makes it impossible to rename or remove authors
> from published packages. See [Cargo PR #15068] for more details.

The optional `authors` field lists in an array the people or organizations that are considered
the "authors" of the package. An optional email address may be included within angled brackets at
Expand All @@ -136,6 +141,8 @@ authors = ["Graydon Hoare", "Fnu Lnu <no-reply@rust-lang.org>"]
This field is surfaced in package metadata and in the `CARGO_PKG_AUTHORS`
environment variable within `build.rs` for backwards compatibility.

[Cargo PR #15068]: https://github.com/rust-lang/cargo/pull/15068

### The `edition` field

The `edition` key is an optional key that affects which [Rust Edition] your package
Expand Down