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

Jump to bottom

use distutils terminology in "PyPI package display" section #61513

Closed
cjerdonek opened this issue Feb 27, 2013 · 7 comments
Closed

use distutils terminology in "PyPI package display" section #61513

cjerdonek opened this issue Feb 27, 2013 · 7 comments
Labels
docs Documentation in the Doc dir stdlib Python modules in the Lib dir type-feature A feature request or enhancement

Comments

@cjerdonek
Copy link
Member

BPO 17311
Nosy @ncoghlan, @vstinner, @tarekziade, @merwok, @cjerdonek, @dstufft
Files
  • issue17311.patch
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2020-10-22.21:19:47.126>
created_at = <Date 2013-02-27.18:16:17.852>
labels = ['type-feature', 'library', 'docs']
title = 'use distutils terminology in "PyPI package display" section'
updated_at = <Date 2020-10-22.21:19:47.126>
user = 'https://github.com/cjerdonek'

    bugs.python.org fields:

    activity = <Date 2020-10-22.21:19:47.126>
actor = 'eric.araujo'
assignee = 'none'
closed = True
closed_date = <Date 2020-10-22.21:19:47.126>
closer = 'eric.araujo'
components = ['Distutils', 'Documentation']
creation = <Date 2013-02-27.18:16:17.852>
creator = 'chris.jerdonek'
dependencies = []
files = ['39876']
hgrepos = []
issue_num = 17311
keywords = ['patch']
message_count = 7.0
messages = ['183169', '183185', '231503', '245896', '246372', '348631', '379351']
nosy_count = 7.0
nosy_names = ['ncoghlan', 'vstinner', 'tarek', 'eric.araujo', 'chris.jerdonek', 'dstufft', 'sanad']
pr_nums = []
priority = 'normal'
resolution = 'out of date'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue17311'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5']
    @cjerdonek
    Copy link
    Member Author

    As suggested by Éric in a Rietveld comment to bpo-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)."

    @cjerdonek cjerdonek added easy stdlib Python modules in the Lib dir docs Documentation in the Doc dir type-feature A feature request or enhancement labels Feb 27, 2013
    @cjerdonek
    Copy link
    Member Author

    The link for convenience:

    http://docs.python.org/dev/distutils/packageindex.html#pypi-package-display

    @merwok
    Copy link
    Member

    merwok commented Nov 21, 2014

    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.

    @merwok merwok assigned ncoghlan and unassigned merwok Nov 21, 2014
    @ncoghlan
    Copy link
    Contributor

    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.

    @ncoghlan ncoghlan removed their assignment Jun 28, 2015
    @sanad
    Copy link
    Mannequin

    sanad mannequin commented Jul 6, 2015

    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.

    @vstinner
    Copy link
    Member

    This issue is 6 years old and has a patch: it is no newcomer friendly, I remove the "easy" keyword.

    @vstinner vstinner removed the easy label Jul 29, 2019
    @merwok
    Copy link
    Member

    merwok commented Oct 22, 2020

    That page has been removed in favour of external guide.

    @merwok merwok closed this as completed Oct 22, 2020
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir stdlib Python modules in the Lib dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    4 participants
    @vstinner @cjerdonek @merwok @ncoghlan