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.

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

Expand the section on the "name" argument #329

Merged
merged 2 commits into from Jun 18, 2017
Merged

Expand the section on the "name" argument #329

merged 2 commits into from Jun 18, 2017

Conversation

jwodder
Copy link
Contributor

@jwodder jwodder commented Jun 18, 2017

Rather than referring readers to a PEP via a link that doesn't even go to the right part of the page, this patch incorporates the salient points on project names from PEPs 426 and 503 into the section on the name argument to the setup() function.

Copy link
Member

@ncoghlan ncoghlan left a comment

Thanks, I think this is definitely a useful improvement.

The reference to the still-in-Draft-form PEP 426 is actually outdated now, so it would make sense to update it before merging this.

characters, see the :pep:`name <426#name>`
section from :pep:`426`.
This is the name of your project, determining how your project is listed on
:term:`PyPI <Python Package Index (PyPI)>`. Per :pep:`426`, valid project
Copy link
Member

@ncoghlan ncoghlan Jun 18, 2017

Choose a reason for hiding this comment

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

This can be updated to refer to the accepted PEP 508 now: https://www.python.org/dev/peps/pep-0508/#names

Copy link
Contributor Author

@jwodder jwodder Jun 18, 2017

Choose a reason for hiding this comment

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

Fixed.

@ncoghlan ncoghlan merged commit 14580ab into pypa:master Jun 18, 2017
1 check passed
@ncoghlan
Copy link
Member

ncoghlan commented Jun 18, 2017

Thanks!

ncoghlan pushed a commit to ncoghlan/python-packaging-user-guide that referenced this issue Jun 24, 2017
Als updates reference to be to PEP 508 instead of 426
@jwodder jwodder deleted the names branch Jun 26, 2017
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.

None yet

2 participants