Description

technillogue

opened on Jan 21, 2024

Issue body actions

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

Linked PRs

• gh-114364: Fix awkward wording about mmap.mmap.seekable being added #114374

Activity

1. technillogue

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on Jan 21, 2024
2. ericvsmith commented on Jan 21, 2024

   

   ericvsmith

   on Jan 21, 2024

   Member

   More actions

   Wouldn't "... when a seekable file-like object is required" sound better?

   I'm not sure what file you should modify.

   Reacted by Erlend E. Aasland
3. terryjreedy commented on Jan 21, 2024

   

   terryjreedy

   on Jan 21, 2024

   Member

   More actions

   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.
4. AA-Turner

   changed the title [-]Awkward wording in :gh:`111835` whatsnew entry[/-] [+]Awkward wording in GH-111835 whatsnew entry[/+] on Jan 21, 2024
5. technillogue commented on Jan 21, 2024

   

   technillogue

   on Jan 21, 2024

   ContributorAuthor

   More actions

   Wouldn't "... when a seekable file-like object is required" sound better?

   maybe "when a file-like object with a :meth:~seekable method is required."? they always had seek()
6. terryjreedy

   closed this as completedin #114374on Feb 1, 2024
7. terryjreedy

   added a commit that references this issue on Feb 1, 2024

   gh-114364: Fix awkward wording about mmap.mmap.seekable (#114374)

   5ce193e
8. aisk

   added a commit that references this issue on Feb 11, 2024

   pythongh-114364: Fix awkward wording about mmap.mmap.seekable (python…

   23a684d

Issue actions