Skip to content

gh-149611: Explain return values for Path.write_text() and Path.write_bytes()#149629

Merged
nedbat merged 4 commits into
python:mainfrom
omkar-334:return-number
May 10, 2026
Merged

gh-149611: Explain return values for Path.write_text() and Path.write_bytes()#149629
nedbat merged 4 commits into
python:mainfrom
omkar-334:return-number

Conversation

@omkar-334

@omkar-334 omkar-334 commented May 10, 2026 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Contributor

pathlib.Path.write_text and pathlib.Path.write_bytes both return an integer from the underlying file object's .write() call (number of characters and number of bytes, respectively), but neither the Sphinx documentation nor the docstrings mention this.

Issue - #149611

@omkar-334 omkar-334 requested a review from barneygale as a code owner May 10, 2026 02:26
@bedevere-app

bedevere-app Bot commented May 10, 2026

Copy link
Copy Markdown

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@python-cla-bot

python-cla-bot Bot commented May 10, 2026 •
edited
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app Bot mentioned this pull request May 10, 2026
Closed
@bedevere-app

bedevere-app Bot commented May 10, 2026

Copy link
Copy Markdown

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@read-the-docs-community

read-the-docs-community Bot commented May 10, 2026 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #32625351 | 📁 Comparing 4e81514 against main (cc5cf14)

  🔍 Preview build  

2 files changed
± library/pathlib.html
± whatsnew/changelog.html

@StanFromIreland StanFromIreland requested a review from nedbat May 10, 2026 07:57
@nedbat

nedbat commented May 10, 2026

Copy link
Copy Markdown
Member

Thanks. I would have thought "Returns" was more correct (file objects' write() docstring uses "Returns"), but there are more "Return" in the .rst files than "Returns", so this is good to go.

@omkar-334

omkar-334 commented May 10, 2026

Copy link
Copy Markdown
Contributor Author

Thanks. I would have thought "Returns" was more correct (file objects' write() docstring uses "Returns"), but there are more "Return" in the .rst files than "Returns", so this is good to go.

Glad to have contributed... Indeed at first look I thought Returns looks better but i noticed the same thing.

@nedbat nedbat enabled auto-merge (squash) May 10, 2026 17:04
@picnixz

picnixz commented May 10, 2026

Copy link
Copy Markdown
Member

(Updating the branch to fix possible CI failures)

@nedbat nedbat merged commit a8e3247 into python:main May 10, 2026
52 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nedbat nedbat nedbat approved these changes

@barneygale barneygale Awaiting requested review from barneygale barneygale is a code owner

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@omkar-334 @nedbat @picnixz