Skip to content

GH-119054: Add "Reading directories" section to pathlib docs #119956

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
Merged
merged 3 commits into from
Jun 6, 2024
Merged

GH-119054: Add "Reading directories" section to pathlib docs #119956

merged 3 commits into from
Jun 6, 2024
+102 −95

Conversation

barneygale
Copy link
Contributor

@barneygale barneygale commented Jun 2, 2024 •
edited by github-actions bot
Loading

Add a dedicated subsection for Path.iterdir()-related methods, specifically iterdir(), glob(), rglob() and walk().

📚 Documentation preview 📚: https://cpython-previews--119956.org.readthedocs.build/

@barneygale
pythonGH-119054: Add "Listing directories" section to pathlib docs
c9a6583 
Add a dedicated subsection for `Path.iterdir()`-related methods,
specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.
@barneygale barneygale added docs Documentation in the Doc dir skip news topic-pathlib needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Jun 2, 2024
@bedevere-app bedevere-app bot mentioned this pull request Jun 2, 2024
Closed
@barneygale
Copy link
Contributor Author

Not sure about "Listing directories" as a title. I considered "Iterating over directories" but it's maybe a touch technical. "Reading directories" is OK. Suggestions?

JelleZijlstra
JelleZijlstra reviewed Jun 3, 2024
View reviewed changes
Copy link
Member

@JelleZijlstra JelleZijlstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I asked my wife for advice since I'm too deep into core development to know what an intuitive name is. Here's some suggestions we came up with:

  • Reading through directories
  • Enumerating directories
  • Listing the contents of directories
  • Iterating over directories

I think I might like "Reading directories" best; it's short and doesn't use an overly technical term.

I also left a few comments on the documentation that you moved. I know they're just being moved around, so feel free to ignore those comments or defer them for a future PR.

barneygale and others added 2 commits June 7, 2024 00:09
@barneygale @JelleZijlstra
Update Doc/library/pathlib.rst
a6a92b5 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@barneygale
Address review feedback
4a49d91
@barneygale barneygale changed the title GH-119054: Add "Listing directories" section to pathlib docs GH-119054: Add "Reading directories" section to pathlib docs Jun 6, 2024
@barneygale
Copy link
Contributor Author

barneygale commented Jun 6, 2024 •
edited
Loading

Thanks v much Jelle (edit: and thanks also to your wife!)

@barneygale barneygale enabled auto-merge (squash) June 6, 2024 23:20
@barneygale barneygale merged commit 14e1506 into python:main Jun 6, 2024
27 checks passed
@miss-islington-app
Copy link

Thanks @barneygale for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Sorry, @barneygale, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 14e1506a6d7056c38fbbc0797268dcf783f91243 3.13

@miss-islington-app
Copy link

Sorry, @barneygale, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 14e1506a6d7056c38fbbc0797268dcf783f91243 3.12

barneygale added a commit to barneygale/cpython that referenced this pull request Jun 6, 2024
@barneygale @JelleZijlstra
pythonGH-119054: Add "Reading directories" section to pathlib docs (p…
778c63a 
…ython#119956)

Add a dedicated subsection for `Path.iterdir()`-related methods,
specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 14e1506)
barneygale added a commit to barneygale/cpython that referenced this pull request Jun 6, 2024
@barneygale
[3.13] pythonGH-119054: Add "Reading directories" section to pathlib …
5ea31de 
…docs (pythonGH-119956)

Add a dedicated subsection for `Path.iterdir()`-related methods,
specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>.
(cherry picked from commit 14e1506)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
barneygale added a commit to barneygale/cpython that referenced this pull request Jun 6, 2024
@barneygale
[3.13] pythonGH-119054: Add "Reading directories" section to pathlib …
303ce1c 
…docs (pythonGH-119956)

Add a dedicated subsection for `Path.iterdir()`-related methods,
specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>.
(cherry picked from commit 14e1506)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Jun 6, 2024

GH-120183 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jun 6, 2024
barneygale added a commit to barneygale/cpython that referenced this pull request Jun 6, 2024
@barneygale @JelleZijlstra
pythonGH-119054: Add "Reading directories" section to pathlib docs (p…
f310da4 
…ython#119956)

Add a dedicated subsection for `Path.iterdir()`-related methods,
specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 14e1506)
barneygale added a commit to barneygale/cpython that referenced this pull request Jun 6, 2024
@barneygale
[3.12] pythonGH-119054: Add "Reading directories" section to pathlib …
24708d9 
…docs (pythonGH-119956)

Add a dedicated subsection for `Path.iterdir()`-related methods,
specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>.
(cherry picked from commit 14e1506)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Jun 6, 2024

GH-120184 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Jun 6, 2024
barneygale added a commit that referenced this pull request Jun 7, 2024
@barneygale @JelleZijlstra
[3.13] GH-119054: Add "Reading directories" section to pathlib docs (G…
d4566c0 
…H-119956) (#120183)

Add a dedicated subsection for `Path.iterdir()`-related methods,
specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.

(cherry picked from commit 14e1506)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
barneygale added a commit that referenced this pull request Jun 7, 2024
@barneygale @JelleZijlstra
[3.12] GH-119054: Add "Reading directories" section to pathlib docs (G…
59224b8 
…H-119956) (#120184)

Add a dedicated subsection for `Path.iterdir()`-related methods,
specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.

(cherry picked from commit 14e1506)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
noahbkim pushed a commit to hudson-trading/cpython that referenced this pull request Jul 11, 2024
@barneygale @JelleZijlstra @noahbkim
pythonGH-119054: Add "Reading directories" section to pathlib docs (p…
49f00fc 
…ython#119956)

Add a dedicated subsection for `Path.iterdir()`-related methods,
specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@barneygale @JelleZijlstra @estyxx
pythonGH-119054: Add "Reading directories" section to pathlib docs (p…
2319d59 
…ython#119956)

Add a dedicated subsection for `Path.iterdir()`-related methods,
specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

Assignees

@barneygale barneygale

Labels
docs Documentation in the Doc dir skip news topic-pathlib
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@barneygale @JelleZijlstra