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

Clarify docstrings of pathlib suffix(es) #82603

Closed
cool-RR mannequin opened this issue Oct 9, 2019 · 5 comments
Closed

Clarify docstrings of pathlib suffix(es) #82603

cool-RR mannequin opened this issue Oct 9, 2019 · 5 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes stdlib Python modules in the Lib dir type-feature A feature request or enhancement

Comments

@cool-RR
Copy link
Mannequin

cool-RR mannequin commented Oct 9, 2019

BPO 38422
Nosy @taleinat, @cool-RR, @miss-islington
PRs
  • bpo-38422: Clarify docstrings of pathlib suffix(es) #16679
  • [3.8] bpo-38422: Clarify docstrings of pathlib suffix(es) (GH-16679) #17031
  • [3.7] bpo-38422: Clarify docstrings of pathlib suffix(es) (GH-16679) #17032
    		•

    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-11-02.17:05:34.461>
created_at = <Date 2019-10-09.15:15:39.205>
labels = ['3.7', '3.8', 'type-feature', 'library', '3.9']
title = 'Clarify docstrings of pathlib suffix(es)'
updated_at = <Date 2019-11-02.17:05:34.461>
user = 'https://github.com/cool-RR'

    bugs.python.org fields:

    activity = <Date 2019-11-02.17:05:34.461>
actor = 'pitrou'
assignee = 'none'
closed = True
closed_date = <Date 2019-11-02.17:05:34.461>
closer = 'pitrou'
components = ['Library (Lib)']
creation = <Date 2019-10-09.15:15:39.205>
creator = 'cool-RR'
dependencies = []
files = []
hgrepos = []
issue_num = 38422
keywords = ['patch']
message_count = 5.0
messages = ['354279', '354508', '355874', '355875', '355876']
nosy_count = 3.0
nosy_names = ['taleinat', 'cool-RR', 'miss-islington']
pr_nums = ['16679', '17031', '17032']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue38422'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']
    @cool-RR
    Copy link
    Mannequin Author

    cool-RR mannequin commented Oct 9, 2019

    I'm writing a PR for this right now.

    @cool-RR cool-RR mannequin added 3.9 only security fixes stdlib Python modules in the Lib dir labels Oct 9, 2019
    @brandtbucher brandtbucher added the type-feature A feature request or enhancement label Oct 11, 2019
    @taleinat
    Copy link
    Contributor

    From the PR, the rationale for this suggestion is:

    "Whenever I use path.suffix I have to check again whether it includes the dot or not. I decided to add it to the docstring so I won't have to keep checking."

    @miss-islington
    Copy link
    Contributor

    New changeset 8d4fef4 by Miss Skeleton (bot) (Ram Rachum) in branch 'master':
    bpo-38422: Clarify docstrings of pathlib suffix(es) (GH-16679)
    8d4fef4

    @pitrou pitrou added 3.7 (EOL) end of life 3.8 only security fixes labels Nov 2, 2019
    @miss-islington
    Copy link
    Contributor

    New changeset aa1fee8 by Miss Skeleton (bot) in branch '3.8':
    bpo-38422: Clarify docstrings of pathlib suffix(es) (GH-16679)
    aa1fee8

    @miss-islington
    Copy link
    Contributor

    New changeset 72b874a by Miss Skeleton (bot) in branch '3.7':
    bpo-38422: Clarify docstrings of pathlib suffix(es) (GH-16679)
    72b874a

    @pitrou pitrou closed this as completed Nov 2, 2019
    @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 3.9 only security fixes 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
    @taleinat @pitrou @miss-islington @brandtbucher