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

Fix pathlib.Path.(r)glob doc glitches. #66260

Closed
terryjreedy opened this issue Jul 24, 2014 · 9 comments
Closed

Fix pathlib.Path.(r)glob doc glitches. #66260

terryjreedy opened this issue Jul 24, 2014 · 9 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@terryjreedy
Copy link
Member

BPO 22062
Nosy @gvanrossum, @terryjreedy, @pitrou, @bitdancer, @serhiy-storchaka, @Mariatta, @adityahase, @miss-islington
PRs
  • bpo-22062: Updated docstring and documentation for pathlib #8519
  • [3.7] bpo-22062: Updated docstring and documentation for pathlib (GH-8519) #11817
  • [3.7] bpo-22062: Updated docstring and documentation for pathlib (GH-8519) #11817
  • [3.7] bpo-22062: Updated docstring and documentation for pathlib (GH-8519) #11817
    		•
    Files
  • pathlib.rst.patch: documentation updates
  • pathlib.py.patch: docstring updates
    		•

    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-02-11.12:03:20.846>
created_at = <Date 2014-07-24.22:11:01.983>
labels = ['3.8', 'type-bug', '3.7', 'docs']
title = 'Fix pathlib.Path.(r)glob doc glitches.'
updated_at = <Date 2019-02-11.12:03:16.555>
user = 'https://github.com/terryjreedy'

    bugs.python.org fields:

    activity = <Date 2019-02-11.12:03:16.555>
actor = 'petr.viktorin'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-02-11.12:03:20.846>
closer = 'petr.viktorin'
components = ['Documentation']
creation = <Date 2014-07-24.22:11:01.983>
creator = 'terry.reedy'
dependencies = []
files = ['41932', '41933']
hgrepos = []
issue_num = 22062
keywords = ['patch']
message_count = 9.0
messages = ['223902', '223903', '257509', '290511', '299001', '299003', '299006', '335206', '335210']
nosy_count = 9.0
nosy_names = ['gvanrossum', 'terry.reedy', 'pitrou', 'r.david.murray', 'docs@python', 'serhiy.storchaka', 'Mariatta', 'adityahase', 'miss-islington']
pr_nums = ['8519', '11817', '11817', '11817']
priority = 'normal'
resolution = None
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue22062'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']
    @terryjreedy
    Copy link
    Member Author

    1. The pattern argument for .(r)glob must be relative. I think the docstrings and doc should say so. /pattern/relative pattern/

    For rglob: '''This is like calling glob() with “**” added in front of the given pattern:'''

    1. Currently "glob()" links to the glob module, which does not recognize '**'. It should link to back up to the Pathlib.glob entry, where the effect of '**' is defined. (I don't currently know the markup for that.)

    2. I interpret '''“**” added in front of the given pattern:''' to mean '**' + pattern, so that '*.py' would become '***.py'. It actually becomes the equivalent of '**/*.p'. So I think '**' should be either '**/' or 'a "**" component'.

    @terryjreedy terryjreedy added the type-bug An unexpected behavior, bug, or error label Jul 24, 2014
    @bitdancer
    Copy link
    Member

    Do non-relative patterns even make sense? I was surprised to get a NotImplementedError instead of a ValueError.

    @gvanrossum
    Copy link
    Member

    Classifying as easy doc bug.

    @gvanrossum gvanrossum added easy docs Documentation in the Doc dir labels Jan 5, 2016
    @serhiy-storchaka
    Copy link
    Member

    Can you create a pull request on GitHub Mike?

    @adityahase
    Copy link
    Mannequin

    adityahase mannequin commented Jul 24, 2017

    Should I create a Github PR with given patch? If so, how do I give credit to the original author?

    @Mariatta
    Copy link
    Member

    Aditya:

    The guideline for converting a patch to the PR is documented here:
    https://devguide.python.org/pullrequest/#converting-an-existing-patch-from-the-b-p-o-to-github

    @terryjreedy
    Copy link
    Member Author

    Since Mike has not responded in more that a week, please go ahead. Just put "“Original patch by Mike Short." in the commit comments (if you can, otherwise add a separate comment). Please add News blurb (see devguide) if you know how, with at least a title line. Mike has signed the CLA, though it would not matter here since his patch is taken from my message and could be classed as trivial.

    @zooba zooba added 3.7 (EOL) end of life 3.8 only security fixes and removed easy labels Jul 28, 2018
    @miss-islington
    Copy link
    Contributor

    New changeset 537b6ca by Miss Islington (bot) (Eivind Teig) in branch 'master':
    bpo-22062: Updated docstring and documentation for pathlib (GH-8519)
    537b6ca

    @miss-islington
    Copy link
    Contributor

    New changeset 2259b5a by Miss Islington (bot) in branch '3.7':
    [3.7] bpo-22062: Updated docstring and documentation for pathlib (GH-8519) (GH-11817)
    2259b5a

    @encukou encukou closed this as completed Feb 11, 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 docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    8 participants
    @encukou @bitdancer @zooba @gvanrossum @serhiy-storchaka @Mariatta @terryjreedy @miss-islington