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
30 of 33 tasks
CAM-Gerlach opened this issue Aug 12, 2022 · 9 comments
Open
30 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:

Prerequisites/General Changes

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>
JelleZijlstra pushed a commit that referenced this issue Oct 24, 2022
* Refine Sphinx syntax and grammar/phrasing in Deprecated section items
* Organize into lang/builtins, modules & stdlib sections
* Convert PEP 594 module list into a grid to not waste as much space
* Add importlib.resources deprecated functions to section
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 24, 2022
…thonGH-98581)

* Refine Sphinx syntax and grammar/phrasing in Deprecated section items
* Organize into lang/builtins, modules & stdlib sections
* Convert PEP 594 module list into a grid to not waste as much space
* Add importlib.resources deprecated functions to section
(cherry picked from commit dfb5d27)

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

(cherry picked from commit 22739a0)

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 24, 2022
…new (pythonGH-98312)

(cherry picked from commit f3f8b6f)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
miss-islington added a commit that referenced this issue Oct 24, 2022
* Refine Sphinx syntax and grammar/phrasing in Deprecated section items
* Organize into lang/builtins, modules & stdlib sections
* Convert PEP 594 module list into a grid to not waste as much space
* Add importlib.resources deprecated functions to section
(cherry picked from commit dfb5d27)

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

(cherry picked from commit f3f8b6f)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
encukou added a commit that referenced this issue Oct 24, 2022
…H-98583)

* Fix names/references of pending removal APIs

* Sort list of APIs pending removal alphabetically

* Add missing modules/submodules pending removal in 3.12

* Add table of unittest deprecated aliases to 3.11 What's New

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 24, 2022
…New (pythonGH-98583)

* Fix names/references of pending removal APIs

* Sort list of APIs pending removal alphabetically

* Add missing modules/submodules pending removal in 3.12

* Add table of unittest deprecated aliases to 3.11 What's New

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
(cherry picked from commit e19c2b9)

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

(cherry picked from commit e2dc223)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 24, 2022
(cherry picked from commit 8dbec4d)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 24, 2022
(cherry picked from commit 43bef54)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this issue Oct 24, 2022
(cherry picked from commit e81fad6)

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 24, 2022
…try (pythonGH-98604)

Followup from pythonGH-98312.
(cherry picked from commit c5a9d3f)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
miss-islington added a commit that referenced this issue Oct 24, 2022
…H-98604)

Followup from GH-98312.
(cherry picked from commit c5a9d3f)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
JelleZijlstra pushed a commit that referenced this issue Oct 25, 2022
…98631)

* Add two line breaks and ref target labels to remaining subsections

* Fix a few out of order Improved Modules

* Fix a few minor textual formatting issues in sections

* Fix remaining Sphinx warnings in the Improved Modules section
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 25, 2022
…dits (pythonGH-98631)

* Add two line breaks and ref target labels to remaining subsections

* Fix a few out of order Improved Modules

* Fix a few minor textual formatting issues in sections

* Fix remaining Sphinx warnings in the Improved Modules section
(cherry picked from commit dd13b23)

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

* Add two line breaks and ref target labels to remaining subsections

* Fix a few out of order Improved Modules

* Fix a few minor textual formatting issues in sections

* Fix remaining Sphinx warnings in the Improved Modules section
(cherry picked from commit dd13b23)

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

* Fix names/references of pending removal APIs

* Sort list of APIs pending removal alphabetically

* Add missing modules/submodules pending removal in 3.12

* Add table of unittest deprecated aliases to 3.11 What's New

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Petr Viktorin <encukou@gmail.com>
(cherry picked from commit e19c2b9)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
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