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

[omkar-334]

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

• Issue: Path.write_text() and Path.write_bytes() don't explain their return value #149611

[bedevere-app]

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]

All commit authors signed the Contributor License Agreement.

[bedevere-app]

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]

Documentation build overview

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

  🔍 Preview build  

2 files changed

± library/pathlib.html
± whatsnew/changelog.html

[nedbat]

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]

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.

[picnixz]

(Updating the branch to fix possible CI failures)