Repository navigation
Awkward wording in GH-111835 whatsnew entry #114364
Description
Documentation
"it requires" is a little unclear
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index 40f0cd37fe..eb00e4ad74 100644
--- a/Doc/whatsnew/3.13.rst
+++ b/Doc/whatsnew/3.13.rst
@@ -259,8 +259,8 @@ mmap
----
* The :class:`mmap.mmap` class now has an :meth:`~mmap.mmap.seekable` method
- that can be used where it requires a file-like object with seekable and
- the :meth:`~mmap.mmap.seek` method return the new absolute position.
+ that can be used when a file-like object with seekable is required. The
+ :meth:`~mmap.mmap.seek` method now returns the new absolute position.
(Contributed by Donghee Na and Sylvie Liberman in :gh:`111835`.)I'm not sure if I should make a PR changing Doc/whatsnew/3.13.rst directly or something via Misc/NEWS.d
This refers #111852
Activity
ericvsmith commentedon Jan 21, 2024
Wouldn't "... when a seekable file-like object is required" sound better?
I'm not sure what file you should modify.
terryjreedy commentedon Jan 21, 2024
The What's new should be edited. If the 3.13.0a?.rst file has the same or similar verbiage, edit it also. Look at the dates of the files and of the merge to guess which.
[-]Awkward wording in :gh:`111835` whatsnew entry[/-][+]Awkward wording in GH-111835 whatsnew entry[/+]technillogue commentedon Jan 21, 2024
maybe "when a file-like object with a :meth:
~seekablemethod is required."? they always hadseek()gh-114364: Fix awkward wording about mmap.mmap.seekable (#114374)
pythongh-114364: Fix awkward wording about mmap.mmap.seekable (python…