Skip to content
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

Edit What's New for Python 3.11 #95913

Open
22 of 33 tasks
CAM-Gerlach opened this issue Aug 12, 2022 · 9 comments
Open
22 of 33 tasks

Edit What's New for Python 3.11 #95913

CAM-Gerlach opened this issue Aug 12, 2022 · 9 comments
Assignees
Labels
3.11 docs Documentation in the Doc dir

Comments

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Aug 12, 2022

As discussed with @pablogsal , this is a meta-issue for coordinating an editing pass on the What's New in Python 3.11 document.

The focus with this issue and its accompanying PRs will be on textual and reST/Sphinx fixes and improvements to the existing content, rather than adding any missing NEWS entries, or touching the organization of the document itself. Another issue, #95914 , will cover adding the PEPs not currently listed to the Summary - Release highlights section, as well as a few PEPs that are not documented at all in What's New, but probably should be somewhere (PEP-624, PEP-654 and PEP-670).

It seems best to split this into separate PRs, one for each top-level section. I've listed them here for reference, with PRs linked as they are submitted:

Pre-/co-requisites

Edit Sections

Add new APIs

Adapted and updated from @pablogsal 's post

Related

@pablogsal
Copy link
Member

pablogsal commented Aug 13, 2022

The following functions has been added in 3.11 and must be (maybe) documented as well:

  • module: zipfile
    added: ['Path.suffix', 'Path.stem', 'Path.suffixes', 'ZipFile.mkdir']
  • module: tempfile
    added: ['SpooledTemporaryFile.detach', 'SpooledTemporaryFile.read1', 'SpooledTemporaryFile.writable', 'SpooledTemporaryFile.readinto1', 'SpooledTemporaryFile.seekable', 'SpooledTemporaryFile.readable', 'SpooledTemporaryFile.readinto']
  • module: hashlib
    added: ['file_digest']
  • module: traceback
    added: ['TracebackException.print', 'StackSummary.format_frame_summary']
  • module: pdb
    added: ['ScriptTarget', 'ModuleTarget']
  • module: inspect
    added: ['FrameInfo']
  • module: contextlib
    added: ['chdir']
  • module: string
    added: ['Template.is_valid', 'Template.get_identifiers']
  • module: enum
    added: ['global_enum_repr', 'global_str', 'show_flag_values', 'global_flag_repr']
  • module: asyncio.tasks
    added: ['Task.cancelling', 'Task.uncancel']
  • module: asyncio.selector_events
    added: ['BaseSelectorEventLoop.sock_recvfrom_into', 'BaseSelectorEventLoop.sock_recvfrom', 'BaseSelectorEventLoop.sock_sendto']
  • module: asyncio.proactor_events
    added: ['BaseProactorEventLoop.sock_recvfrom_into', 'BaseProactorEventLoop.sock_recvfrom', 'BaseProactorEventLoop.sock_sendto']
  • module: asyncio.sslproto
    added: ['SSLProtocolState', 'AppProtocolState', 'add_flowcontrol_defaults', 'SSLProtocol.get_buffer', 'SSLProtocol.buffer_updated']
  • module: asyncio.runners
    added: ['Runner']
  • module: asyncio.exceptions
    added: ['BrokenBarrierError']
  • module: asyncio.windows_events
    added: ['IocpProactor.recvfrom_into']
  • module: logging.handlers
    added: ['SysLogHandler.createSocket']

@pablogsal
Copy link
Member

pablogsal commented Aug 13, 2022

CC: @tiran @iritkatriel @asvetlov @ambv as you were involved in some of the changes (and the dev in residence for awareness).

@tiran
Copy link
Member

tiran commented Aug 13, 2022

hashlib.file_digest is covered by gh-95965.

@iritkatriel
Copy link
Member

iritkatriel commented Aug 14, 2022

@jaraco should pdb.ScriptTarget pdb.ModuleTarget be documented? I think they were intended to be implementation details.

@jaraco
Copy link
Member

jaraco commented Aug 14, 2022

@jaraco should pdb.ScriptTarget pdb.ModuleTarget be documented? I think they were intended to be implementation details.

Correct. Those are implementation details.

iritkatriel added a commit to iritkatriel/cpython that referenced this issue Aug 17, 2022
@CAM-Gerlach CAM-Gerlach changed the title Copyedit/Proofread What's New for Python 3.11 Edit What's New for Python 3.11 Aug 17, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 18, 2022
…Target private (pythonGH-96053)

(cherry picked from commit 1a720c6)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 18, 2022
…ythonGH-95980)

(cherry picked from commit c5bc67b)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
iritkatriel added a commit that referenced this issue Aug 18, 2022
) (GH-96064)

(cherry picked from commit c5bc67b)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
pablogsal pushed a commit that referenced this issue Aug 18, 2022
…tTarget private (GH-96053) (#96063)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
tiran pushed a commit to tiran/cpython that referenced this issue Aug 19, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Sep 19, 2022
…New (pythonGH-95915)

(cherry picked from commit 8ee27e3)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
encukou pushed a commit that referenced this issue Sep 19, 2022
…t's New (GH-96097)


Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 19, 2022
…H-98314)

* Link ZipFile in What's New entry discussing it

* Add entry for new ZipFile.mkdir method

* Add entry for new zipfile.Path.stem/suffix/suffixes methods

* Add missing line breaks between zipfile bullet list items
(cherry picked from commit ed827d560831b054d262818b1777f7879e8fbd3e)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
miss-islington added a commit that referenced this issue Oct 19, 2022
* Add entry for new logging.getLevelNamesMapping function

* Add entry for SysLogHandler.createSocket to whatsnew

* Add missing line break between logging bullet list items
(cherry picked from commit 251b8cc)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
miss-islington added a commit that referenced this issue Oct 19, 2022
* Link ZipFile in What's New entry discussing it

* Add entry for new ZipFile.mkdir method

* Add entry for new zipfile.Path.stem/suffix/suffixes methods

* Add missing line breaks between zipfile bullet list items
(cherry picked from commit ed827d5)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 22, 2022
…pythonGH-98304)

(cherry picked from commit 8f30267)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 22, 2022
…H-98426)

(cherry picked from commit f58631b)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
…) (#98554)

gh-95913: Edit & expand Optimizations in 3.11 WhatsNew (GH-98426)
(cherry picked from commit f58631b)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
miss-islington added a commit that referenced this issue Oct 22, 2022
…8304)

(cherry picked from commit 8f30267)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
…H-97720)

* Add and refine reST/Sphinx syntax for implementation changes section

* Clarify and refine wording in the Implementation Changes section

* Elide unnecessary comma

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 4e73181)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
…H-97719)

* Add/refine cross references to items in other lang changes section

* Unify context manager exception changes into single non-repetitive item

* More clearly describe the intent and consequences of the -P option

* Apply minor clarifications & copyedits to rest of section

* Tweak the formatting of module references

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit a77d9de)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
…GH-97718)

* Move Windows py.exe improvements from Typing section to New Features

* Add ref target label and use literal for py.exe

* Be clearer/explict about what legacy version arg components reprisent

* Apply other minor clarity and textual fixes to py.exe launcher text

* Refine phrasing of legacy sentence of py.exe desc

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 9859581)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 9fbfa42)

Co-authored-by: Guido van Rossum <guido@python.org>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
What's New: Fix PEP number in PEP 678 ref target label
(cherry picked from commit e738b51)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
* Link TOML & WSGI in New Modules section, refine text & add ref label

* Further reformat new modules & add PEP link to tomllib
(cherry picked from commit bd00112)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
…t's New (GH-96097)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 558768f)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
…H-95915)

(cherry picked from commit 8ee27e3)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
…) (#98554)

gh-95913: Edit & expand Optimizations in 3.11 WhatsNew (GH-98426)
(cherry picked from commit f58631b)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
* Add line breaks & ref targets to Whatsnew to prepare for future changes

* Use standard heading underbar symbols for H4 sections

* Flatten Porting subsection; clarify scope of/link Python->CAPI sections

* Move C API pending deprecations to C API section, to match the others
pablogsal pushed a commit that referenced this issue Oct 22, 2022
…t's New (GH-96097)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 558768f)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
…8304)

(cherry picked from commit 8f30267)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
* Add entry for new logging.getLevelNamesMapping function

* Add entry for SysLogHandler.createSocket to whatsnew

* Add missing line break between logging bullet list items
(cherry picked from commit 251b8cc)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
* Link ZipFile in What's New entry discussing it

* Add entry for new ZipFile.mkdir method

* Add entry for new zipfile.Path.stem/suffix/suffixes methods

* Add missing line breaks between zipfile bullet list items
(cherry picked from commit ed827d5)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 22, 2022
* Whatsnew: Convert literals in enum section to actual x-references

* Whatsnew: Rewrite enum section for clear and consistant phrasing

* Whatsnew: Combine directly related enum items instead of seperating them

* gh-98250: Describe __str__/__format__ changes more clearly/accurately

* Tweak enum section language per feedback from Ethan
(cherry picked from commit 73e5180)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
iritkatriel added a commit to iritkatriel/cpython that referenced this issue Oct 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 docs Documentation in the Doc dir
Projects
Status: In Progress
Development

No branches or pull requests

7 participants