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

Documentation - capitalization issue #79510

Closed
HStry mannequin opened this issue Nov 27, 2018 · 6 comments
Closed

Documentation - capitalization issue #79510

HStry mannequin opened this issue Nov 27, 2018 · 6 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@HStry
Copy link
Mannequin

HStry mannequin commented Nov 27, 2018

BPO 35329
Nosy @benjaminp, @csabella, @miss-islington, @utkarsh2102, @HStry
PRs
  • bpo-35329: Update documentation #13008
  • [3.7] closes bpo-35329: Change 'Package' to 'package' in accordance with PEP8. (GH-13008) #13018
  • [2.7] closes bpo-35329: Change 'Package' to 'package' in accordance with PEP8. (GH-13008) #13019
  • 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 2019-04-30.02:20:10.831>
    created_at = <Date 2018-11-27.16:43:56.703>
    labels = ['3.8', 'type-feature', '3.7', 'docs']
    title = 'Documentation - capitalization issue'
    updated_at = <Date 2019-04-30.02:26:03.134>
    user = 'https://github.com/HStry'

    bugs.python.org fields:

    activity = <Date 2019-04-30.02:26:03.134>
    actor = 'miss-islington'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2019-04-30.02:20:10.831>
    closer = 'benjamin.peterson'
    components = ['Documentation']
    creation = <Date 2018-11-27.16:43:56.703>
    creator = 'Strijker'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 35329
    keywords = ['patch']
    message_count = 6.0
    messages = ['330537', '340305', '341067', '341132', '341133', '341134']
    nosy_count = 6.0
    nosy_names = ['benjamin.peterson', 'docs@python', 'cheryl.sabella', 'miss-islington', 'utkarsh2102', 'Strijker']
    pr_nums = ['13008', '13018', '13019']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue35329'
    versions = ['Python 3.7', 'Python 3.8']

    @HStry
    Copy link
    Mannequin Author

    HStry mannequin commented Nov 27, 2018

    In the documentation I noticed "from Package import specific_submodule". I recon package should be all lowercase in accordance with PEP-8.
    (https://www.python.org/dev/peps/pep-0008/#package-and-module-names)

    It may be far from the most important bug ever, but it's my first bug reported, and gotta start small... :-)

    https://docs.python.org/3/tutorial/modules.html#importing-from-a-package

    6.4.1. Importing * From a Package
    ...
    Remember, there is nothing wrong with using from Package import specific_submodule! In fact, this is the recommended notation unless the importing module needs to use submodules with the same name from different packages.

    @HStry HStry mannequin added the 3.7 (EOL) end of life label Nov 27, 2018
    @HStry HStry mannequin assigned docspython Nov 27, 2018
    @HStry HStry mannequin added the docs Documentation in the Doc dir label Nov 27, 2018
    @csabella
    Copy link
    Contributor

    Hi Hans,

    Would you be interested in making a pull request with this change? Thanks!

    @csabella csabella added 3.8 only security fixes type-feature A feature request or enhancement labels Apr 15, 2019
    @utkarsh2102
    Copy link
    Mannequin

    utkarsh2102 mannequin commented Apr 29, 2019

    Hey,

    I'd be happy to submit one :)

    @benjaminp
    Copy link
    Contributor

    New changeset ee0309f by Benjamin Peterson (Utkarsh Gupta) in branch 'master':
    closes bpo-35329: Change 'Package' to 'package' in accordance with PEP-8. (GH-13008)
    ee0309f

    @miss-islington
    Copy link
    Contributor

    New changeset 3e5c4a7 by Miss Islington (bot) in branch '2.7':
    closes bpo-35329: Change 'Package' to 'package' in accordance with PEP-8. (GH-13008)
    3e5c4a7

    @miss-islington
    Copy link
    Contributor

    New changeset 4b5340b by Miss Islington (bot) in branch '3.7':
    closes bpo-35329: Change 'Package' to 'package' in accordance with PEP-8. (GH-13008)
    4b5340b

    @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
    Labels
    3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Development

    No branches or pull requests

    3 participants