Skip to content

Commit

Permalink
Auto merge of #10938 - ptdecker:add-author-example, r=weihanglo
Browse files Browse the repository at this point in the history
This change adds an example to the authors attribute in the manifest.

It is submitted to clarify the documenation for new folks such as
myself. See the forum issue linked below which prompted this change
since the error message the compiler issues is not clear for new
folks.

https://users.rust-lang.org/t/compile-error-when-adding-authors-to-cargo-toml/79383

Thank you for considering this contribution. It's my first so go
easy on me please!  :-)
  • Loading branch information
bors committed Sep 21, 2022
2 parents 23ab870 + 51dc6fb commit 635a848
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/doc/src/reference/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,18 @@ breaking change.
<a id="the-authors-field-optional"></a>
#### The `authors` field

The optional `authors` field lists people or organizations that are considered
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 end of each author entry.

```toml
[package]
# ...
authors = ["Graydon Hoare", "Fnu Lnu <no-reply@rust-lang.org>"]
```

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.
Expand Down

0 comments on commit 635a848

Please sign in to comment.