Skip to content

docs: use well-known project URL labels in the pyproject.toml tutorial - #823

Merged
InessaPawson merged 2 commits into
pyOpenSci:mainfrom
simonvanlierde:fix-project-urls-labels
Oct 13, 2026
Merged

InessaPawson merged 2 commits into
pyOpenSci:mainfrom
simonvanlierde:fix-project-urls-labels

Conversation

@simonvanlierde

Copy link
Copy Markdown
Contributor

Hi! This closes #800.

The pyproject.toml tutorial uses "Bug Reports" as a project.urls label. That label isn't on the PyPA list of well-known project URL labels, so PyPI and other indexes can't tell it points to the issue tracker.

  • "Bug Reports" normalizes to bugreports, and the list only has issues and its aliases (bugs, issue, tracker, issuetracker, bugtracker). I renamed it to "Issues" in the three examples on the page and in the matching bullet. Homepage and Source were already on the list.
  • I added a sentence after the bullets that links the list, and the tip now names a few more labels from it (Documentation, Changelog, Funding). The links-demo README stays, since it shows how the labels look on PyPI.
  • I kept the title-case keys the page already uses, which is also what the PyPA Writing your pyproject.toml guide shows. use/link to well known labels for project.urls #800 suggested lowercase (homepage, issues). Both normalize the same, so happy to switch if you prefer.

Tests: nox -s docs-test passes locally, and so do the translated builds. I didn't touch the .po files.

Best,

Simon

@netlify

netlify Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for python-package-guide ready!

Name Link
🔨 Latest commit c8cc64b
🔍 Latest deploy log https://app.netlify.com/projects/python-package-guide/deploys/6acec47ec6ca5617ed7ba5eb
😎 Deploy Preview https://deploy-preview-823--python-package-guide.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment thread tutorials/pyproject-toml.md Outdated
simonvanlierde and others added 2 commits October 13, 2026 19:53
"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.
@InessaPawson
InessaPawson force-pushed the fix-project-urls-labels branch from 43de6bc to c8cc64b Compare October 13, 2026 23:53
@InessaPawson

Copy link
Copy Markdown
Contributor

@simonvanlierde Thank you, Simon! Let’s keep the title-case quoted keys as they match the PyPA pyproject.toml guide.

@InessaPawson
InessaPawson merged commit a0a1175 into pyOpenSci:main Oct 13, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

use/link to well known labels for project.urls

2 participants