-
-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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
GH-119054: Add "Reading and writing files" section to pathlib docs #119524
Conversation
Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And backport to 3.12?
The docs in 3.12 aren't wrong, they're just a bit disorganised! I guess I'm trying to apply the bugfix vs feature/performance improvement distinction here. But I don't know much about the docs workflow 😅. Do you think backporting is the right thing to do here? If so I'll backport #119055 too. |
In general, it's good to backport docs. That's because the default https://docs.python.org/ redirects to https://docs.python.org/3/ which is the latest stable, currently 3.12. Most people visit this default. If we only merge it to Therefore, it makes sense to backport docs changes, even if they're not "bug fixes" as such, but improvements like better organisation. Plus backporting keeps each branch closer in sync, making it easier to backport other things. |
Thanks very much for the explanation, and the review! :) |
Thanks @barneygale for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
…ocs (pythonGH-119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`. (cherry picked from commit bd6d4ed) Co-authored-by: Barney Gale <barney.gale@gmail.com>
GH-119954 is a backport of this pull request to the 3.13 branch. |
Sorry, @barneygale, I could not cleanly backport this to
|
…ocs (python#119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`. (cherry picked from commit bd6d4ed)
…thlib docs (pythonGH-119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.. (cherry picked from commit bd6d4ed) Co-authored-by: Barney Gale <barney.gale@gmail.com>
GH-119955 is a backport of this pull request to the 3.12 branch. |
…ocs (python#119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.
…ocs (python#119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.
…ocs (python#119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.
…ocs (python#119524) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`.
Add a dedicated subsection for
open()
,read_text()
,read_bytes()
,write_text()
andwrite_bytes()
.📚 Documentation preview 📚: https://cpython-previews--119524.org.readthedocs.build/