Skip to content

package.authors is deprecated without explanation #16458

@GideonBear

Description

@GideonBear

Ref #15068, ping @epage

https://doc.rust-lang.org/cargo/reference/manifest.html#the-authors-field

The authors field
Warning: This field is deprecated
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 the end of each author entry.
[...]
This field is surfaced in package metadata and in the CARGO_PKG_AUTHORS environment variable within build.rs for backwards compatibility.

I found this in the docs, and had no clue what to do. A warning just saying "This field is deprecated" is not very useful, in my opinion. I was very confused. After a bit of research, I now know why it was deprecated. I propose adding a (short) explanation as to why it was deprecated, possibly a link to the RFC making it optional (which AFAICT contains most of the rationale for deprecating it), and note that you do not need anything to replace it.

Secondly, I think "(deprecated)" should be added in the table of contents:

authors — The authors of the package.

Just like was done with [replace]:

[replace] — Override dependencies (deprecated).

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-documenting-cargo-itselfArea: Cargo's documentationS-needs-designStatus: Needs someone to work further on the design for the feature or fix. NOT YET accepted.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions