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
Comments
The following functions has been added in 3.11 and must be (maybe) documented as well:
|
CC: @tiran @iritkatriel @asvetlov @ambv as you were involved in some of the changes (and the dev in residence for awareness). |
|
@jaraco should pdb.ScriptTarget pdb.ModuleTarget be documented? I think they were intended to be implementation details. |
Correct. Those are implementation details. |
…Target private (pythonGH-96053) (cherry picked from commit 1a720c6) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
…ythonGH-95980) (cherry picked from commit c5bc67b) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
…New (pythonGH-95915) (cherry picked from commit 8ee27e3) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
…t's New (GH-96097) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
…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>
* 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>
* 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>
…pythonGH-98304) (cherry picked from commit 8f30267) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
…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>
…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>
…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>
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>
* 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
* 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>
* 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>
* 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>
CAM-Gerlach commentedAug 12, 2022
•
edited
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
!
in C domain ref target syntax #97740Edit Sections
Enum.__str__
change could be improved in What's New #98250Add new APIs
Adapted and updated from @pablogsal 's post
added: ['BrokenBarrierError']
(Already implicitly referred to by Barrier mention, but will be linked directly in editing pass)
GH-95913: Update what's new in 3.11 for asyncio #97806
module: asyncio.proactor_eventsadded: ['BaseProactorEventLoop.sock_recvfrom_into', 'BaseProactorEventLoop.sock_recvfrom', 'BaseProactorEventLoop.sock_sendto']
(Already added; will be improved in editing phase)
added: ['Runner']
GH-95913: Update what's new in 3.11 for asyncio #97806
module: asyncio.selector_eventsadded: ['BaseSelectorEventLoop.sock_recvfrom_into', 'BaseSelectorEventLoop.sock_recvfrom', 'BaseSelectorEventLoop.sock_sendto']
(Already added; will be improved in editing phase)
GH-95913: Update what's new in 3.11 for asyncio #97806
module: asyncio.sslprotoadded: ['SSLProtocolState', 'AppProtocolState', 'add_flowcontrol_defaults', 'SSLProtocol.get_buffer', 'SSLProtocol.buffer_updated']
(Considered implementation details, so @kumaraditya303 says no need to be documented (indeed, I don't see it documented anywhere else but the changelog)
added: ['Task.cancelling', 'Task.uncancel']
GH-95913: Update what's new in 3.11 for asyncio #97806
module: asyncio.windows_eventsadded: ['IocpProactor.recvfrom_into']
(Appears to be undocumented implementation detail of the added socket methods)
added: ['chdir']
bpo-25625: Document contextlib.chdir in the 3.11 what's new #95962
added: ['global_enum_repr', 'global_str', 'show_flag_values', 'global_flag_repr']
(Not documented yet, and
ReprEnum
andglobal_enum
mentioned in What's New aren't either)Document new 3.11 enum APIs (ReprEnum, global_* and/or show_flag_values) #98298
gh-98298: [Enum] document ReprEnum, global_enum, and show_flag_values #98455
added: ['file_digest']
gh-89313: Add hashlib.file_digest to whatsnew 3.11 #95965
gh-95913: Add traceback module additions to what's new in 3.11 #95980
added: ['FrameInfo']
Already discussed, just not explicitly referenced
gh-95913: Copyedit & xref FrameInfo in Whatsnew inspect section #98304
added: ['SysLogHandler.createSocket']
(Not documented yet; seems like it should be?)
Logging: SysLogHandler.createSocket added in 3.11 but not documented #98307
gh-98307: Add docstring and documentation for SysLogHandler.createSocket (GH-98319) #98319
gh-95913: Add WhatsNew section for new logging APIs #98320
module: pdbadded: ['ScriptTarget', 'ModuleTarget']
(Made private)
gh-95913: make the new internal classes pdb.ModuleTarget/ScriptTarget private #96053
added: ['Template.is_valid', 'Template.get_identifiers']
gh-95913 Add string section to Whatsnew with new Template methods #98311
added: ['SpooledTemporaryFile.detach', 'SpooledTemporaryFile.read1', 'SpooledTemporaryFile.writable', 'SpooledTemporaryFile.readinto1', 'SpooledTemporaryFile.seekable', 'SpooledTemporaryFile.readable', 'SpooledTemporaryFile.readinto']
gh-95913: Add io support for SpooledTemporaryFile in Whatsnew #98312
added: ['TracebackException.print', 'StackSummary.format_frame_summary']
gh-95913: Add traceback module additions to what's new in 3.11 #95980
added: ['Path.suffix', 'Path.stem', 'Path.suffixes', 'ZipFile.mkdir']
gh-95913: Edit zipfile Whatsnew section & add new APIs #98314
Related
The text was updated successfully, but these errors were encountered: