GH-121462: pathlib docs: improve table of corresponding os/os.path functions #121465
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…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.
barneygale
added
docs
hugovk
approved these changes
Jul 27, 2024
|
Thank you Hugo! |
|
Thanks @barneygale for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Jul 27, 2024
…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]>
|
Sorry, @barneygale, I could not cleanly backport this to |
|
GH-122359 is a backport of this pull request to the 3.13 branch. |
barneygale
added a commit
to barneygale/cpython
that referenced
this pull request
Jul 27, 2024
…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]>
|
GH-122360 is a backport of this pull request to the 3.12 branch. |
barneygale
added a commit
that referenced
this pull request
Jul 27, 2024
…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 pull request
Jul 27, 2024
…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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Re-order table of corresponding functions with the following priorities:
os.pathfunctions are shown beforeosfunctionsAdd a few missed correspondences:
os.path.isjunction()andPath.is_junction()os.path.ismount()andPath.is_mount()os.lstat()andPath.lstat()os.lchmod()andPath.lchmod()Also add footnotes describing a few differences.
📚 Documentation preview 📚: https://cpython-previews--121465.org.readthedocs.build/