Skip to content

[3.13] GH-121462: pathlib docs: improve table of corresponding os/os.path functions (GH-121465) #122359

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

Merged
merged 1 commit into from
Jul 27, 2024

Conversation

miss-islington
Copy link
Contributor

@miss-islington miss-islington commented Jul 27, 2024

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]


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

…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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news topic-pathlib
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants