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

Conversation

@jwodder
Copy link
Contributor

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.

@ncoghlan
Copy link
Member

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

This comment has been minimized.

Copy link
@ncoghlan

ncoghlan Jun 18, 2017

Member

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

This comment has been minimized.

Copy link
@jwodder

jwodder Jun 18, 2017

Author Contributor

Fixed.

@ncoghlan ncoghlan merged commit 14580ab into pypa:master Jun 18, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@ncoghlan

This comment has been minimized.

Copy link
Member

commented Jun 18, 2017

Thanks!

ncoghlan added a commit to ncoghlan/python-packaging-user-guide that referenced this pull request Jun 24, 2017

Expand the section on the "name" argument (pypa#329)
Als updates reference to be to PEP 508 instead of 426

@jwodder jwodder deleted the jwodder:names branch Jun 26, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.