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.

Sign up for GitHub

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

Documentation for email.utils is named email.util.rst #79216

Closed
zmwangx mannequin opened this issue Oct 21, 2018 · 6 comments
Closed

Documentation for email.utils is named email.util.rst #79216

zmwangx mannequin opened this issue Oct 21, 2018 · 6 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir

Comments

@zmwangx
Copy link
Mannequin

zmwangx mannequin commented Oct 21, 2018

BPO 35035
Nosy @bitdancer, @JulienPalard, @zmwangx, @miss-islington
PRs
  • bpo-35035: Rename email.utils documentation to email.utils.rst #10023
  • [3.7] bpo-35035: Rename email.utils documentation to email.utils.rst (GH-10023) #10635
  • [3.6] bpo-35035: Rename email.utils documentation to email.utils.rst (GH-10023) #10636
  • [2.7] bpo-35035: Rename email.utils documentation to email.utils.rst (GH-10023) #10667
    		•

    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 2018-11-22.22:29:08.244>
created_at = <Date 2018-10-21.06:17:19.122>
labels = ['3.7', '3.8', 'docs']
title = 'Documentation for email.utils is named email.util.rst'
updated_at = <Date 2018-11-26.17:09:57.067>
user = 'https://github.com/zmwangx'

    bugs.python.org fields:

    activity = <Date 2018-11-26.17:09:57.067>
actor = 'mdk'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-11-22.22:29:08.244>
closer = 'mdk'
components = ['Documentation']
creation = <Date 2018-10-21.06:17:19.122>
creator = 'zmwangx'
dependencies = []
files = []
hgrepos = []
issue_num = 35035
keywords = ['patch']
message_count = 6.0
messages = ['328190', '328601', '330196', '330198', '330199', '330284']
nosy_count = 5.0
nosy_names = ['r.david.murray', 'docs@python', 'mdk', 'zmwangx', 'miss-islington']
pr_nums = ['10023', '10635', '10636', '10667']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue35035'
versions = ['Python 3.7', 'Python 3.8']
    @zmwangx
    Copy link
    Mannequin Author

    zmwangx mannequin commented Oct 21, 2018

    Documentation for PSL module email.utils is named email.util.rst. See <https://docs.python.org/3/library/email.util.html\>.

    This seems to violate the principle of least surprise. (I have a command line tool to open documentation for any PSL module, and I found this name mismatch when I used that with email.utils.) It should be named email.utils.rst instead, unless there's a specific reason not to.

    @zmwangx zmwangx mannequin added 3.7 (EOL) end of life 3.8 only security fixes labels Oct 21, 2018
    @zmwangx zmwangx mannequin assigned docspython Oct 21, 2018
    @zmwangx zmwangx mannequin added the docs Documentation in the Doc dir label Oct 21, 2018
    @bitdancer
    Copy link
    Member

    Sure, this is fine with me.

    @JulienPalard
    Copy link
    Member

    New changeset 361e868 by Julien Palard (Zhiming Wang) in branch 'master':
    bpo-35035: Rename email.utils documentation to email.utils.rst (GH-10023)
    361e868

    @JulienPalard
    Copy link
    Member

    New changeset 27c16e3 by Julien Palard (Miss Islington (bot)) in branch '3.6':
    bpo-35035: Rename email.utils documentation to email.utils.rst (GH-10023)
    27c16e3

    @JulienPalard
    Copy link
    Member

    New changeset 3b7258a by Julien Palard (Miss Islington (bot)) in branch '3.7':
    [3.7] bpo-35035: Rename email.utils documentation to email.utils.rst (GH-10023)
    3b7258a

    @miss-islington
    Copy link
    Contributor

    New changeset daa34b8 by Miss Islington (bot) (Julien Palard) in branch '2.7':
    [2.7] bpo-35035: Rename email.utils documentation to email.utils.rst (GH-10023) (GH-10667)
    daa34b8

    @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
    3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @JulienPalard @bitdancer @miss-islington