Skip to content

Commit

Permalink
allow authors to be a TOML array
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbyrne committed Nov 27, 2023
1 parent 5610445 commit ed48896
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/src/toml-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"},
]
```


Expand Down

0 comments on commit ed48896

Please sign in to comment.