Skip to content

pathlib docs: table of corresponding os/os.path functions is disorganised #121462

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
Closed
barneygale opened this issue Jul 7, 2024 · 0 comments
Closed

pathlib docs: table of corresponding os/os.path functions is disorganised #121462

barneygale opened this issue Jul 7, 2024 · 0 comments
Labels
3.12 only security fixes 3.13 bugs and security fixes 3.14 bugs and security fixes docs Documentation in the Doc dir topic-pathlib

Comments

@barneygale
Copy link
Contributor

barneygale commented Jul 7, 2024 •
edited by bedevere-app bot
Loading

Documentation

The Corresponding tools table in the pathlib docs has evolved organically and is overdue some editing.

Linked PRs
@barneygale barneygale added docs Documentation in the Doc dir 3.12 only security fixes topic-pathlib 3.13 bugs and security fixes 3.14 bugs and security fixes labels Jul 7, 2024
barneygale added a commit to barneygale/cpython that referenced this issue Jul 7, 2024
@barneygale
pythonGH-121462: pathlib docs: improve table of corresponding os/os.p…
187cf8f 
…ath functions

Re-order table of corresponding functions with the following priorities:

1. Pure functionality is at the top
2. `os.path` functions are shown before `os` functions
3. Similar functionality is kept together
4. Functionality follows docs order where possible

Add a few missed correspondences:

- `os.path.isjunction` and `Path.is_junction`
- `os.path.ismount` and `Path.is_mount`
- `os.lstat()` and `Path.lstat()`
- `os.lchmod()` and `Path.lchmod()`

Also add footnotes describing a few differences.
@bedevere-app bedevere-app bot mentioned this issue Jul 7, 2024
Merged
barneygale added a commit to barneygale/cpython that referenced this issue Jul 8, 2024
@barneygale
Merge branch 'main' into pythongh-121462
ae75b23
barneygale added a commit that referenced this issue Jul 27, 2024
@barneygale
GH-121462: pathlib docs: improve table of corresponding os/os.path fu…
cbac8a3 
…nctions (#121465)

Re-order table of corresponding functions with the following priorities:

1. Pure functionality is at the top
2. `os.path` functions are shown before `os` functions
3. Similar functionality is kept together
4. Functionality follows docs order where possible

Add a few missed correspondences:

- `os.path.isjunction` and `Path.is_junction`
- `os.path.ismount` and `Path.is_mount`
- `os.lstat()` and `Path.lstat()`
- `os.lchmod()` and `Path.lchmod()`

Also add footnotes describing a few differences.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 27, 2024
@barneygale @miss-islington
pythonGH-121462: pathlib docs: improve table of corresponding os/os.p…
40a2e6f 
…ath functions (pythonGH-121465)

Re-order table of corresponding functions with the following priorities:

1. Pure functionality is at the top
2. `os.path` functions are shown before `os` functions
3. Similar functionality is kept together
4. Functionality follows docs order where possible

Add a few missed correspondences:

- `os.path.isjunction` and `Path.is_junction`
- `os.path.ismount` and `Path.is_mount`
- `os.lstat()` and `Path.lstat()`
- `os.lchmod()` and `Path.lchmod()`

Also add footnotes describing a few differences.
(cherry picked from commit cbac8a3)

Co-authored-by: Barney Gale <[email protected]>
@bedevere-app bedevere-app bot mentioned this issue Jul 27, 2024
Merged
barneygale added a commit to barneygale/cpython that referenced this issue Jul 27, 2024
@barneygale
[3.12] pythonGH-121462: pathlib docs: improve table of corresponding …
a151dc6 
…os/os.path functions (pythonGH-121465)

Re-order table of corresponding functions with the following priorities:

1. Pure functionality is at the top
2. `os.path` functions are shown before `os` functions
3. Similar functionality is kept together
4. Functionality follows docs order where possible

Add a few missed correspondences:

- `os.path.isjunction` and `Path.is_junction`
- `os.path.ismount` and `Path.is_mount`
- `os.lstat()` and `Path.lstat()`
- `os.lchmod()` and `Path.lchmod()`

Also add footnotes describing a few differences..
(cherry picked from commit cbac8a3)

Co-authored-by: Barney Gale <[email protected]>
@bedevere-app bedevere-app bot mentioned this issue Jul 27, 2024
Merged
barneygale added a commit that referenced this issue Jul 27, 2024
@barneygale
[3.12] GH-121462: pathlib docs: improve table of corresponding os/os.…
8205c16 
…path functions (GH-121465) (#122360)

Re-order table of corresponding functions with the following priorities:

1. Pure functionality is at the top
2. `os.path` functions are shown before `os` functions
3. Similar functionality is kept together
4. Functionality follows docs order where possible

Add a few missed correspondences:

- `os.path.isjunction` and `Path.is_junction`
- `os.path.ismount` and `Path.is_mount`
- `os.lstat()` and `Path.lstat()`
- `os.lchmod()` and `Path.lchmod()`

Also add footnotes describing a few differences.

(cherry picked from commit cbac8a3)
barneygale added a commit that referenced this issue Jul 27, 2024
@miss-islington @barneygale
[3.13] GH-121462: pathlib docs: improve table of corresponding os/os.…
a93f97c 
…path functions (GH-121465) (#122359)

Re-order table of corresponding functions with the following priorities:

1. Pure functionality is at the top
2. `os.path` functions are shown before `os` functions
3. Similar functionality is kept together
4. Functionality follows docs order where possible

Add a few missed correspondences:

- `os.path.isjunction` and `Path.is_junction`
- `os.path.ismount` and `Path.is_mount`
- `os.lstat()` and `Path.lstat()`
- `os.lchmod()` and `Path.lchmod()`

Also add footnotes describing a few differences.

(cherry picked from commit cbac8a3)

Co-authored-by: Barney Gale <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3.12 only security fixes 3.13 bugs and security fixes 3.14 bugs and security fixes docs Documentation in the Doc dir topic-pathlib
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@barneygale