From 35c50e2114e8c598af267dd7818ea77a3f89eef9 Mon Sep 17 00:00:00 2001 From: Simon van Lierde Date: Tue, 13 Oct 2026 05:28:23 +0200 Subject: [PATCH 1/2] docs: use well-known project URL labels in the pyproject.toml tutorial "Bug Reports" is not on the PyPA list of well-known project URL labels, so indexes cannot treat it as the issue tracker. Use "Issues", and link the list from the step that introduces project.urls. --- tutorials/pyproject-toml.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/tutorials/pyproject-toml.md b/tutorials/pyproject-toml.md index cb6b3e4b..5de5047c 100644 --- a/tutorials/pyproject-toml.md +++ b/tutorials/pyproject-toml.md @@ -503,9 +503,11 @@ Finally, add the project.urls table to your pyproject.toml file. `project.urls` contains links that are relevant for your project. You might want to include: - **Homepage:** A link to your published documentation for your project. If you are working through this tutorial, then you may not have this link yet. That's ok, you can skip it for the time being. -- **Bug reports:** a link to your issues/discussions or wherever you want users to report bugs. +- **Issues:** a link to your issues/discussions or wherever you want users to report bugs. - **Source:** the GitHub / GitLab link for your project. +These three names are on the PyPA list of [well-known project URL labels](https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels). The list lets package indexes such as PyPI present project URLs in a consistent way, so pick a label from it when one fits. + {emphasize-lines="34-37"} ```toml [build-system] @@ -543,12 +545,12 @@ classifiers = [ [project.urls] # Optional "Homepage" = "https://www.pyopensci.org" -"Bug Reports" = "https://github.com/pyopensci/pyosmeta/issues" +"Issues" = "https://github.com/pyopensci/pyosmeta/issues" "Source" = "https://github.com/pyopensci/pyosmeta/" ``` :::{tip} -There are many other urls that you can add here. Check out the [README file here for an overview](https://github.com/patrick91/links-demo). +There are many other urls that you can add here, such as `Documentation`, `Changelog` or `Funding` from the same list. Check out the [README file here for an overview](https://github.com/patrick91/links-demo). ::: ## Putting it all together - your completed pyproject.toml file @@ -592,7 +594,7 @@ classifiers = [ [project.urls] # Optional "Homepage" = "https://www.pyopensci.org" -"Bug Reports" = "https://github.com/pyopensci/pyosmeta/issues" +"Issues" = "https://github.com/pyopensci/pyosmeta/issues" "Source" = "https://github.com/pyopensci/pyosmeta/" ``` @@ -660,7 +662,7 @@ license = "MIT" # Add urls for your home page, issue tracker and source code [project.urls] # Optional "Homepage" = "https://www.pyopensci.org" -"Bug Reports" = "https://github.com/pyopensci/pyospackage/issues" +"Issues" = "https://github.com/pyopensci/pyospackage/issues" #"Funding" = "" "Source" = "https://github.com/pyopensci/pyospackage" ``` From c8cc64ba372151ad08b83eeefadf3443f36632bf Mon Sep 17 00:00:00 2001 From: Inessa Pawson Date: Tue, 13 Oct 2026 19:52:05 -0400 Subject: [PATCH 2/2] docs: clarify the Homepage label --- tutorials/pyproject-toml.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/pyproject-toml.md b/tutorials/pyproject-toml.md index 5de5047c..734082db 100644 --- a/tutorials/pyproject-toml.md +++ b/tutorials/pyproject-toml.md @@ -502,7 +502,7 @@ Finally, add the project.urls table to your pyproject.toml file. `project.urls` contains links that are relevant for your project. You might want to include: -- **Homepage:** A link to your published documentation for your project. If you are working through this tutorial, then you may not have this link yet. That's ok, you can skip it for the time being. +- **Homepage:** A link to your project’s website. For many packages this is often the documentation site. If you are working through this tutorial, then you may not have this link yet. That's ok, you can skip it for the time being. - **Issues:** a link to your issues/discussions or wherever you want users to report bugs. - **Source:** the GitHub / GitLab link for your project.