Issue 22062: Fix pathlib.Path.(r)glob doc glitches. (original) (raw)

Created on 2014-07-24 22:11 by terry.reedy, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
pathlib.rst.patch Mike.Short,2016-02-16 02:52 documentation updates review
pathlib.py.patch Mike.Short,2016-02-16 03:03 docstring updates review
Pull Requests
URL Status Linked Edit
PR 8519 merged eivl,2018-07-28 11:14
PR 11817 merged miss-islington,2019-02-11 10:47
PR 11817 merged miss-islington,2019-02-11 10:47
PR 11817 merged miss-islington,2019-02-11 10:47
Messages (9)
msg223902 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2014-07-24 22:11
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:''' 2. 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.) 3. 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'.
msg223903 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-07-24 22:23
Do non-relative patterns even make sense? I was surprised to get a NotImplementedError instead of a ValueError.
msg257509 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2016-01-05 01:55
Classifying as easy doc bug.
msg290511 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2017-03-26 07:05
Can you create a pull request on GitHub Mike?
msg299001 - (view) Author: Aditya Hase (adityahase) * Date: 2017-07-24 17:32
Should I create a Github PR with given patch? If so, how do I give credit to the original author?
msg299003 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-07-24 17:46
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
msg299006 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2017-07-24 17:59
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.
msg335206 - (view) Author: miss-islington (miss-islington) Date: 2019-02-11 10:47
New changeset 537b6caa565ec2fc304ba6f4400cd347ce2af64b by Miss Islington (bot) (Eivind Teig) in branch 'master': bpo-22062: Updated docstring and documentation for pathlib (GH-8519) https://github.com/python/cpython/commit/537b6caa565ec2fc304ba6f4400cd347ce2af64b
msg335210 - (view) Author: miss-islington (miss-islington) Date: 2019-02-11 12:03
New changeset 2259b5af3c711b40d2b81eacc1b5d75cda1ae3e2 by Miss Islington (bot) in branch '3.7': [3.7] bpo-22062: Updated docstring and documentation for pathlib (GH-8519) (GH-11817) https://github.com/python/cpython/commit/2259b5af3c711b40d2b81eacc1b5d75cda1ae3e2
History
Date User Action Args
2022-04-11 14:58:06 admin set github: 66260
2019-02-11 12:03:20 petr.viktorin set status: open -> closedstage: patch review -> resolved
2019-02-11 12:03:05 miss-islington set messages: +
2019-02-11 10:47:35 miss-islington set pull_requests: + <pull%5Frequest11838>
2019-02-11 10:47:34 miss-islington set pull_requests: + <pull%5Frequest11839>
2019-02-11 10:47:33 miss-islington set pull_requests: + <pull%5Frequest11837>
2019-02-11 10:47:14 miss-islington set nosy: + miss-islingtonmessages: +
2018-07-28 12:22:58 steve.dower set keywords: - easy
2018-07-28 12:20:27 steve.dower set versions: + Python 3.6, Python 3.7, Python 3.8, - Python 3.4, Python 3.5
2018-07-28 11:14:21 eivl set stage: needs patch -> patch reviewpull_requests: + <pull%5Frequest8034>
2017-07-24 17:59:31 terry.reedy set messages: +
2017-07-24 17:46:55 Mariatta set nosy: + Mariattamessages: +
2017-07-24 17:32:19 adityahase set nosy: + adityahasemessages: +
2017-03-26 07:05:25 serhiy.storchaka set nosy: + serhiy.storchakamessages: +
2016-02-16 03:03:06 Mike.Short set files: + pathlib.py.patch
2016-02-16 02:52:55 Mike.Short set files: + pathlib.rst.patchkeywords: + patch
2016-01-05 01:55:09 gvanrossum set nosy: + docs@python, gvanrossummessages: + assignee: docs@pythoncomponents: + Documentationkeywords: + easy
2014-07-24 22:23:24 r.david.murray set nosy: + r.david.murraymessages: +
2014-07-24 22:11:01 terry.reedy create