From a828cbc808778b946cffb0be3ec679344a19df3e Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Sat, 30 Nov 2024 19:33:54 +0100 Subject: [PATCH 1/2] Improve license and license-files docs --- docs/config/metadata.md | 25 +++++++++---------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/docs/config/metadata.md b/docs/config/metadata.md index c7b415792..55f433ebf 100644 --- a/docs/config/metadata.md +++ b/docs/config/metadata.md @@ -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, +`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 From 722fbb2d4edeec0e434131b6145088011297086c Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Sun, 8 Dec 2024 19:40:49 +0100 Subject: [PATCH 2/2] Add link for SPDX license expression --- docs/config/metadata.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/config/metadata.md b/docs/config/metadata.md index 55f433ebf..010ae4e27 100644 --- a/docs/config/metadata.md +++ b/docs/config/metadata.md @@ -99,7 +99,8 @@ requires-python = ">=3.8" ## License -For more information, see [PEP 639][]. `license` must be a valid SPDX license expression, +For more information, see [PEP 639][]. `license` must be a valid +[SPDX license expression](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*']`.