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

Improve license and license-files docs #1831

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve license and license-files docs #1831

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a828cbc
Improve license and license-files docs
cdce8p Nov 30, 2024
722fbb2
Add link for SPDX license expression
cdce8p Dec 8, 2024
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
25 changes: 9 additions & 16 deletions docs/config/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,25 +99,18 @@ requires-python = ">=3.8"

## License

For more information, see [PEP 639][].
For more information, see [PEP 639][]. `license` must be a valid SPDX license expression,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the latter part could also directly link to the catalog of such identifiers (https://spdx.org/licenses/).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the latter part could also directly link to the catalog of such identifiers (https://spdx.org/licenses/).

I explicitly didn't want to do that since those are only identifiers and a license expression could be more complex. Added a link to the relevant PEP section instead. It also cross references the SPDX identifier list.

https://peps.python.org/pep-0639/#spdx-license-expression-syntax

`license-files` a list of glob patterns which match license files. If not specified,
`license-files` will default to `['LICEN[CS]E*', 'COPYING*', 'NOTICE*', 'AUTHORS*']`.

=== ":octicons-file-code-16: pyproject.toml"

=== "SPDX expression"

```toml
[project]
...
license = "Apache-2.0 OR MIT"
```

=== "Files"

```toml
[project]
...
license-files = ["LICENSES/*"]
```
```toml
[project]
...
license = "Apache-2.0 OR MIT"
license-files = ["LICENSES/*"]
```

## Ownership

Expand Down