-
-
Notifications
You must be signed in to change notification settings - Fork 271
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5610445
commit ed48896
Showing
1 changed file
with
13 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,11 +22,20 @@ are described below. | |
|
||
### The `authors` field | ||
|
||
For a package, the optional `authors` field is a list of strings describing the | ||
package authors, in the form `NAME <EMAIL>`. For example: | ||
For a package, the optional `authors` field is a TOML array describing the package authors. | ||
Entries in the array can either be a string in the form `NAME <EMAIL>`, or arrays with the following keys: | ||
- `name` (required): the name of the author | ||
- `email`: email address | ||
- `orcid`: 16-digit [ORCID](https://orcid.org/) identifier as a string | ||
- `github`: [GitHub](https://github.com/) username | ||
|
||
For example: | ||
```toml | ||
authors = ["Some One <[email protected]>", | ||
"Foo Bar <[email protected]>"] | ||
authors = [ | ||
"Some One <[email protected]>", | ||
"Foo Bar <[email protected]>", | ||
{name = "Baz Qux", email = "[email protected]", orcid = "0000-0001-8048-6810"}, | ||
] | ||
``` | ||
|
||
|
||
|