New submission from Chris Jerdonek:

I think the Package Index (PyPI) documentation would be clearer if the section 
called "Uploading Packages to the Package Index":

http://docs.python.org/3.4/distutils/uploading.html

were made a part of the previous section about PyPI (now called "Registering 
with the Package Index"):

http://docs.python.org/3.4/distutils/packageindex.html

The combined section could then be renamed simply to "The Python Package Index 
(PyPI)".

Both sections are small and very closely related.  For example, the second half 
of the section on uploading (the subsection called "PyPI package display") is 
not actually about uploading but rather about registering and PyPI in general.  
Similarly, the second half of the first section on registering (the subsection 
called "The .pypirc file") applies equally to uploading as it does to 
registering.

I was affected by the current organization, for example, because it gave the 
impression that uploading updates the PyPI package display (which is 
conceivable since PKG-INFO is part of the uploaded files).  Rather, it is 
registering a version which updates the package display for that version.

A combined section on PyPI would better reflect how things should be understood.

----------
assignee: eric.araujo
components: Distutils, Documentation
keywords: easy
messages: 174825
nosy: chris.jerdonek, eric.araujo, ezio.melotti, georg.brandl, tarek
priority: normal
severity: normal
status: open
title: move the "Uploading Packages" section to distutils/packageindex.rst
type: enhancement
versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4

_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue16406>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to