classification
Title: use distutils terminology in "PyPI package display" section
Type: enhancement Stage: needs patch
Components: Distutils, Documentation Versions: Python 3.4, Python 3.5, Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: chris.jerdonek, dstufft, eric.araujo, ncoghlan, sanad, tarek
Priority: normal Keywords: easy, patch

Created on 2013-02-27 18:16 by chris.jerdonek, last changed 2015-07-06 16:49 by sanad.

Files
File name Uploaded Description Edit
issue17311.patch sanad, 2015-07-06 16:49 review
Messages (5)
msg183169 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2013-02-27 18:16
As suggested by Éric in a Rietveld comment to issue 16406, this issue is to make the "PyPI package display" section of the distutils docs use the right terminology:

"It’s too bad this part of the documentation use “package” with the meaning used on PyPI instead of following the naming conventions used in the rest of the distutils docs (see glossary).  Here I don’t know when “package” and “home page” mean pypi.python.org/project or pypi.python.org/project/release (the former being a shortcut to the latest release page)."
msg183185 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2013-02-27 20:59
The link for convenience:

http://docs.python.org/dev/distutils/packageindex.html#pypi-package-display
msg231503 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2014-11-21 23:36
Nick being the current shepherd for packaging discussions and the instigator of the new version-independent documentation, I’d like to let him take a decision on this.
msg245896 - (view) Author: Nick Coghlan (ncoghlan) * (Python committer) Date: 2015-06-28 03:20
Sorry for the long silence on this one folks.

I agree the use of "package" and "home page" in the referenced section is confusing. For "home page", I'd suggest using the phrase "distribution page" instead (unless Donald has a different suggestion based on his current work on the next generation PyPI implementation).

As far as the ambiguous "package" goes, for the PyPA docs, we ended up settling on the following set of terms (from https://packaging.python.org/en/latest/glossary.html):

  import package = the runtime meaning of the term "package"
  distribution package = the PyPI meaning of the term "package"
  distribution = shortened term for "distribution package"
  package = short for either "import package" or "distribution package", depending on context. For a great many packages, there's a one-to-one correspondence between the import package and the distribution package, which is why folks are often surprised to learn there's a difference.

With the distutils docs normally using "package" to mean "import package", then they should use the explicit "distribution" or "distribution package" when they mean the other sense.
msg246372 - (view) Author: sanad (sanad) * Date: 2015-07-06 16:49
In an attempt to fix this issue on lines of the criteria given by nick, have uploaded my patch . Please review it so that If mistake is there ,I can fix and upload corrected patch again. Thanks for your time.
History
Date User Action Args
2015-07-06 16:49:25sanadsetfiles: + issue17311.patch

nosy: + sanad
messages: + msg246372

keywords: + patch
2015-06-28 03:20:04ncoghlansetassignee: ncoghlan ->

messages: + msg245896
nosy: + dstufft
2014-11-21 23:36:24eric.araujosetversions: + Python 3.5, - Python 3.2, Python 3.3
nosy: + ncoghlan

messages: + msg231503

assignee: eric.araujo -> ncoghlan
2013-02-27 20:59:04chris.jerdoneksetmessages: + msg183185
2013-02-27 18:16:17chris.jerdonekcreate