[3.13] GH-119054: Add "Expanding and resolving paths" section to pathlib docs. (GH-120970)#121155
Merged
Merged
Conversation
…ib docs. (pythonGH-120970) Add dedicated subsection for `home()`, `expanduser()`, `cwd()`, `absolute()`, `resolve()` and `readlink()`. The position of this section keeps all the `Path` constructors (`Path()`, `Path.from_uri()`, `Path.home()` and `Path.cwd()`) near the top. Within the section, closely related methods are kept adjacent. Specifically: -.`home()` and `expanduser()` (the former calls the latter) - `cwd()` and `absolute()` (the former calls the latter) - `absolute()` and `resolve()` (both make paths absolute) - `resolve()` and `readlink()` (both read symlink targets) - Ditto `cwd()` and `absolute()` - Ditto `absolute()` and `resolve()` The "Other methods" section is removed. (cherry picked from commit d6d8707) Co-authored-by: Barney Gale <barney.gale@gmail.com>
bedevere-app
Bot
added
docs
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add dedicated subsection for
home(),expanduser(),cwd(),absolute(),resolve()andreadlink(). The position of this sectionkeeps all the
Pathconstructors (Path(),Path.from_uri(),Path.home()andPath.cwd()) near the top. Within the section, closelyrelated methods are kept adjacent. Specifically:
-.
home()andexpanduser()(the former calls the latter)cwd()andabsolute()(the former calls the latter)absolute()andresolve()(both make paths absolute)resolve()andreadlink()(both read symlink targets)cwd()andabsolute()absolute()andresolve()The "Other methods" section is removed.
(cherry picked from commit d6d8707)
Co-authored-by: Barney Gale barney.gale@gmail.com
📚 Documentation preview 📚: https://cpython-previews--121155.org.readthedocs.build/