-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Description
https://doc.rust-lang.org/cargo/reference/manifest.html#the-authors-field
The
authorsfield
Warning: This field is deprecated
The optionalauthorsfield 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 theCARGO_PKG_AUTHORSenvironment variable withinbuild.rsfor 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).