Skip to content
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

docs(ref): Deprecate 'package.authors' #15068

Merged
merged 2 commits into from
Jan 16, 2025
Merged

docs(ref): Deprecate 'package.authors' #15068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a18d72
docs(ref): Remove uses of 'package.authors' that isn't documenting so…
epage Jan 15, 2025
32d6e9d
docs(ref): Deprecate 'package.authors'
epage Jan 15, 2025
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
16 changes: 5 additions & 11 deletions src/doc/src/reference/manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ The first section in a `Cargo.toml` is `[package]`.
[package]
name = "hello_world" # the name of the package
version = "0.1.0" # the current version, obeying semver
authors = ["Alice <[email protected]>", "Bob <[email protected]>"]
```

The only field required by Cargo is [`name`](#the-name-field). If publishing to
Expand Down Expand Up @@ -121,10 +120,10 @@ This field is optional and defaults to `0.0.0`. The field is required for publi

### 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. The exact meaning is open to interpretation --- it
may list the original or primary authors, current maintainers, or owners of the
package. An optional email address may be included within angled brackets at
the "authors" of the package. An optional email address may be included within angled brackets at
the end of each author entry.

```toml
Expand All @@ -133,13 +132,8 @@ the end of each author entry.
authors = ["Graydon Hoare", "Fnu Lnu <[email protected]>"]
```

This field is only surfaced in package metadata and in the `CARGO_PKG_AUTHORS`
environment variable within `build.rs`. It is not displayed in the [crates.io]
user interface.

> **Warning**: Package manifests cannot be changed once published, so this
> field cannot be changed or removed in already-published versions of a
> package.
This field is surfaced in package metadata and in the `CARGO_PKG_AUTHORS`
environment variable within `build.rs` for backwards compatibility.

### The `edition` field

Expand Down
2 changes: 0 additions & 2 deletions src/doc/src/reference/workspaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ where the workspace's `Cargo.toml` is located.
[package]
name = "hello_world" # the name of the package
version = "0.1.0" # the current version, obeying semver
authors = ["Alice <[email protected]>", "Bob <[email protected]>"]
```

### Virtual workspace
Expand All @@ -77,7 +76,6 @@ resolver = "2"
name = "hello_world" # the name of the package
version = "0.1.0" # the current version, obeying semver
edition = "2024" # the edition, will have no effect on a resolver used in the workspace
authors = ["Alice <[email protected]>", "Bob <[email protected]>"]
```

By having a workspace without a root package,
Expand Down
Loading