-
-
Notifications
You must be signed in to change notification settings - Fork 29.3k
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
Documentation of pathlib.Path methods is disorganised #119054
Labels
Comments
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
May 14, 2024
…ib docs Add a dedicated subsection for `Path.stat()`-related methods, specifically `stat()`, `lstat()`, `exists()`, `is_*()`, and `samefile()`.
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
May 24, 2024
barneygale
added a commit
that referenced
this issue
May 24, 2024
#119055) Add a dedicated subsection for `Path.stat()`-related methods, specifically `stat()`, `lstat()`, `exists()`, `is_*()`, and `samefile()`.
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
May 24, 2024
Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 2, 2024
…ib docs (python#119055) Add a dedicated subsection for `Path.stat()`-related methods, specifically `stat()`, `lstat()`, `exists()`, `is_*()`, and `samefile()`. (cherry picked from commit 81d6336)
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 2, 2024
…o pathlib docs (pythonGH-119055) Add a dedicated subsection for `Path.stat()`-related methods, specifically `stat()`, `lstat()`, `exists()`, `is_*()`, and `samefile()`.. (cherry picked from commit 81d6336) Co-authored-by: Barney Gale <barney.gale@gmail.com>
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 2, 2024
…ib docs (python#119055) Add a dedicated subsection for `Path.stat()`-related methods, specifically `stat()`, `lstat()`, `exists()`, `is_*()`, and `samefile()`. (cherry picked from commit 81d6336)
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 2, 2024
…o pathlib docs (pythonGH-119055) Add a dedicated subsection for `Path.stat()`-related methods, specifically `stat()`, `lstat()`, `exists()`, `is_*()`, and `samefile()`.. (cherry picked from commit 81d6336) Co-authored-by: Barney Gale <barney.gale@gmail.com>
barneygale
added a commit
that referenced
this issue
Jun 2, 2024
barneygale
added a commit
that referenced
this issue
Jun 2, 2024
barneygale
added a commit
that referenced
this issue
Jun 2, 2024
…119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Jun 2, 2024
…ocs (pythonGH-119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`. (cherry picked from commit bd6d4ed) Co-authored-by: Barney Gale <barney.gale@gmail.com>
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 2, 2024
…ocs (python#119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`. (cherry picked from commit bd6d4ed)
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 2, 2024
…thlib docs (pythonGH-119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.. (cherry picked from commit bd6d4ed) Co-authored-by: Barney Gale <barney.gale@gmail.com>
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 2, 2024
Add a dedicated subsection for `Path.iterdir()`-related methods, specifically `iterdir()`, `glob()`, `rglob()` and `walk()`.
barneygale
added a commit
that referenced
this issue
Jun 2, 2024
mliezun
pushed a commit
to mliezun/cpython
that referenced
this issue
Jun 3, 2024
…ocs (python#119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 5, 2024
…ocs (python#119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.
barneygale
added a commit
that referenced
this issue
Jun 6, 2024
Add a dedicated subsection for `Path.iterdir()`-related methods, specifically `iterdir()`, `glob()`, `rglob()` and `walk()`. Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 6, 2024
…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 issue
Jun 6, 2024
…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 issue
Jun 6, 2024
…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 issue
Jun 6, 2024
…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 issue
Jun 6, 2024
…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 issue
Jun 7, 2024
…lib docs. Add dedicated subsection for `pathlib.Path.touch()`, `mkdir()`, `symlink_to()` and `hardlink_to()`. Also note that `open()`, `write_text()` and `write_bytes()` are often used to create files.
barneygale
added a commit
that referenced
this issue
Jun 13, 2024
…cs. (#120186) Add dedicated subsection for `pathlib.Path.touch()`, `mkdir()`, `symlink_to()` and `hardlink_to()`. Also note that `open()`, `write_text()` and `write_bytes()` are often used to create files. Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Jun 13, 2024
…lib docs. (pythonGH-120186) Add dedicated subsection for `pathlib.Path.touch()`, `mkdir()`, `symlink_to()` and `hardlink_to()`. Also note that `open()`, `write_text()` and `write_bytes()` are often used to create files. (cherry picked from commit c2d810b) Co-authored-by: Barney Gale <barney.gale@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 13, 2024
…to pathlib docs. (pythonGH-120186) Add dedicated subsection for `pathlib.Path.touch()`, `mkdir()`, `symlink_to()` and `hardlink_to()`. Also note that `open()`, `write_text()` and `write_bytes()` are often used to create files. Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>. (cherry picked from commit c2d810b) Co-authored-by: Barney Gale <barney.gale@gmail.com>
barneygale
added a commit
that referenced
this issue
Jun 13, 2024
…hlib docs. (GH-120186) (#120462) GH-119054: Add "Creating files and directories" section to pathlib docs. (GH-120186) Add dedicated subsection for `pathlib.Path.touch()`, `mkdir()`, `symlink_to()` and `hardlink_to()`. Also note that `open()`, `write_text()` and `write_bytes()` are often used to create files. (cherry picked from commit c2d810b) Co-authored-by: Barney Gale <barney.gale@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Jun 13, 2024
…pythonGH-120465) Add dedicated subsection for `pathlib.Path.rename()`, `replace()`, `unlink()` and `rmdir()`. (cherry picked from commit d88a1f2) Co-authored-by: Barney Gale <barney.gale@gmail.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Jun 13, 2024
…pythonGH-120465) Add dedicated subsection for `pathlib.Path.rename()`, `replace()`, `unlink()` and `rmdir()`. (cherry picked from commit d88a1f2) Co-authored-by: Barney Gale <barney.gale@gmail.com>
barneygale
added a commit
to barneygale/cpython
that referenced
this issue
Jun 14, 2024
…ocs. Add dedicated subsection for `pathlib.owner()`, `group()`, `chmod()` and `lchmod()`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Documentation
The docs for
pathlib.Path
methods is disorganised. It was originally alphabetical, but over the last few years we've begun moving similar methods together. We ought to split it up into sections, to make it easier to navigate and absorb, e.g.:If this granularity is too fine, we could stick more stuff in "Other methods".
Linked PRs
The text was updated successfully, but these errors were encountered: