Skip to content
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

[3.12] GH-119054: Add "Expanding and resolving paths" section to pathlib docs. (GH-120970) #121156

Merged
merged 1 commit into from
Jun 29, 2024

Conversation

barneygale
Copy link
Contributor

@barneygale barneygale commented Jun 29, 2024

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)


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

…o pathlib 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 <[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.

1 participant