docs(ref): Deprecate 'workspace.package.authors'#16951
Conversation
rustbot
added
A-documenting-cargo-itself
|
r? @ehuss rustbot has assigned @ehuss. Use Why was this reviewer chosen?The reviewer was selected based on:
|
Signed-off-by: Sebastian Walz <sebastian.walz@secunet.com>
sivizius
force-pushed
the
deprecate-workspace-authors
branch
from
68ee44e to
93eee6e
Compare
| - Commands run in the workspace root will run against all workspace | ||
| members by default, see [`default-members`](#the-default-members-field). | ||
|
|
||
| ## The `members` and `exclude` fields |
There was a problem hiding this comment.
I guess, my editor automatically removed leading whitespace?
| * [`name`](#the-name-field) --- The name of the package. | ||
| * [`version`](#the-version-field) --- The version of the package. | ||
| * [`authors`](#the-authors-field) --- The authors of the package. | ||
| * [`authors`](#the-authors-field) --- The authors of the package (deprecated). |
There was a problem hiding this comment.
Technically unrelated to this PR, but IMHO an annotation here similar to the replace below (line 55ish) is useful so one doesn’t need to scroll down to see the warning.
|
|
||
| [workspace.package] | ||
| version = "1.2.3" | ||
| authors = ["Nice Folks"] |
There was a problem hiding this comment.
If it’s deprecated, there is no point in including it in an example.
There was a problem hiding this comment.
Sorry for those changes, my editor removed trailing whitespace…not sure if I should leave those or if it’s ok?
There was a problem hiding this comment.
Yes, all the unrelated whitespace changes should not be included.
| > **Warning**: The `authors` field is deprecated | ||
|
|
There was a problem hiding this comment.
I think given that this is emphasized in many places (in particular the definition of the authors field itself) that this extra warning probably isn't necessary here.
4 participants
What does this PR try to resolve?
In #15068,
package.authorswas deprecated. There isn’t really a point in supportingworkspace.package.authorswhich is used asauthors.workspace = true, which was deprecated by the aforementioned PR. Various third-party tools, e.g. https://www.schemastore.org/cargo.json, already consider the workspace field as deprecated as well.r? @ehuss @epage