mirror of
https://github.com/python/cpython.git
synced 2026-06-18 23:53:28 +00:00
7756f59892
gh-150319: Replace all documentation which says "See PEP 585" (#150325) * Replace all documentation which says "See PEP 585" The following classes in the stdlib get simple updates: - array.array - asyncio.Future - asyncio.Task - collections.defaultdict - collections.deque - contextvars.ContextVar - contextvars.Token - ctypes.Array - os.DirEntry - re.Match - re.Pattern - string.templatelib.Interpolation - string.templatelib.Template - types.MappingProxyType - queue.SimpleQueue - weakref.ref The following classes are documented publicly as functions, and are therefore updated internally (`__class_getitem__.__doc__`) but not in the public docs: - functools.partial - itertools.chain The following builtin types have updates to `__class_getitem__.__doc__` but not to any documentation pages: - BaseExceptionGroup - coroutines (from generators) - dict - enumerate - frozendict - frozenset - generators (and async generators) - list - memoryview - set - slice - tuple Special cases: - union objects are now documented as "supporting class-level []", rather than anything to do with generics. - Templates might be generic over a single type (union, in theory) or over a TypeVarTuple. As this is not currently fully settled, it is marked with a comment and a mild hint that it is a single type is used (namely, "type" is singular rather than "types", plural) * Apply suggestions from code review * Correct several class getitem docs And expand the text for tuples. * Add notes on generic typing of builtins * Fix typo in tuple.__class_getitem__ docstring * Typo fix: malformed refs Fix `generic` links which weren't marked as `:ref:`. * Strike unnecessary docs on generic-ness * Apply suggestions from code review These are applied at both the originally indicated locations and in the corresponding docstring definitions. * Update Doc/library/re.rst * Update Objects/enumobject.c * Remove tuple generic doc in 'stdtypes' page This is covered in more detail in the cross-linked typing documentation. The other copy of this documentation -- in the docstring for `tuple.__class_getitem__` -- is left in place. * Fix whitespace around new doc of generics Per review, do not introduce or remove whitespace such that section breaks are altered by the introduction of doc on various generic types. In most cases, this is a removal of an extra line. In one case (Arrays), it is the reintroduction of a line. Additionally, two other minor fixes are included: - incorrect indent on 'defaultdicts' - make `mappingproxy.__class_getitem__.__doc__` consistent with other mapping type generic docs * Move placement of memoryview generic note Previous placement was at the end of the main docstring, which is consistent with other types but places it after a section on various methods (which makes it read somewhat inconsistently). Moving it up helps resolve. * Ensure sphinxdoc does not start sentences lowercase Lowercase class names at the start of sentences are marked out with the `class` role. In the case of `deque`, documentation already refers to these as `Deques`, so this form is preferred. * Apply suggestions from code review * Fix line endings and wrap more tightly Line endings fixed by pre-commit ; also re-wrapped the MappingProxyType text which was too long. * Use 'ContextVars' style in sphinx doc --------- Co-authored-by: Stephen Rosen <sirosen@globus.org> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Jelle Zijlstra <906600+JelleZijlstra@users.noreply.github.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| abstract.rst | ||
| allocation.rst | ||
| apiabiversion.rst | ||
| arg.rst | ||
| bool.rst | ||
| buffer.rst | ||
| bytearray.rst | ||
| bytes.rst | ||
| call.rst | ||
| capsule.rst | ||
| cell.rst | ||
| code.rst | ||
| codec.rst | ||
| complex.rst | ||
| concrete.rst | ||
| contextvars.rst | ||
| conversion.rst | ||
| coro.rst | ||
| curses.rst | ||
| datetime.rst | ||
| descriptor.rst | ||
| dict.rst | ||
| exceptions.rst | ||
| extension-modules.rst | ||
| file.rst | ||
| float.rst | ||
| frame.rst | ||
| function.rst | ||
| gcsupport.rst | ||
| gen.rst | ||
| hash.rst | ||
| import.rst | ||
| index.rst | ||
| init.rst | ||
| init_config.rst | ||
| interp-lifecycle.rst | ||
| intro.rst | ||
| iter.rst | ||
| iterator.rst | ||
| lifecycle.dot | ||
| lifecycle.dot.css | ||
| lifecycle.dot.pdf | ||
| lifecycle.dot.svg | ||
| lifecycle.rst | ||
| list.rst | ||
| long.rst | ||
| mapping.rst | ||
| marshal.rst | ||
| memory.rst | ||
| memoryview.rst | ||
| method.rst | ||
| module.rst | ||
| monitoring.rst | ||
| none.rst | ||
| number.rst | ||
| object.rst | ||
| objimpl.rst | ||
| perfmaps.rst | ||
| picklebuffer.rst | ||
| profiling.rst | ||
| refcounting.rst | ||
| reflection.rst | ||
| sequence.rst | ||
| set.rst | ||
| slice.rst | ||
| stable.rst | ||
| structures.rst | ||
| subinterpreters.rst | ||
| synchronization.rst | ||
| sys.rst | ||
| threads.rst | ||
| time.rst | ||
| tls.rst | ||
| tuple.rst | ||
| type.rst | ||
| typehints.rst | ||
| typeobj.rst | ||
| unicode.rst | ||
| utilities.rst | ||
| veryhigh.rst | ||
| weakref.rst | ||
