From 311fd96dae5156b46e0eca982c12dd6bad00adf5 Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Sun, 27 Aug 2023 16:59:35 -0700 Subject: [3.12] Docs: Resolve Sphinx warnings in dis.rst (GH-108476) (#108546) Docs: Resolve Sphinx warnings in dis.rst (GH-108476) - Link to the code objects reference - Suppress link to deliberately undocumented builtins.__build_class__ - Suppress links for example methods (cherry picked from commit cb1184280b3fb369a07abb4153aa36829cf1df9b) Co-authored-by: Erlend E. Aasland --- Doc/library/dis.rst | 20 +++++++++++--------- Doc/reference/datamodel.rst | 4 +++- Doc/tools/.nitignore | 1 - 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst index 085fd2b..6fadccf 100644 --- a/Doc/library/dis.rst +++ b/Doc/library/dis.rst @@ -43,13 +43,13 @@ interpreter. adaptive bytecode can be shown by passing ``adaptive=True``. -Example: Given the function :func:`myfunc`:: +Example: Given the function :func:`!myfunc`:: def myfunc(alist): return len(alist) the following command can be used to display the disassembly of -:func:`myfunc`: +:func:`!myfunc`: .. doctest:: @@ -793,7 +793,7 @@ iterations of the loop. .. opcode:: LOAD_BUILD_CLASS - Pushes :func:`builtins.__build_class__` onto the stack. It is later called + Pushes :func:`!builtins.__build_class__` onto the stack. It is later called to construct a class. @@ -851,14 +851,14 @@ iterations of the loop. .. opcode:: STORE_NAME (namei) Implements ``name = STACK.pop()``. *namei* is the index of *name* in the attribute - :attr:`co_names` of the code object. The compiler tries to use - :opcode:`STORE_FAST` or :opcode:`STORE_GLOBAL` if possible. + :attr:`!co_names` of the :ref:`code object `. + The compiler tries to use :opcode:`STORE_FAST` or :opcode:`STORE_GLOBAL` if possible. .. opcode:: DELETE_NAME (namei) - Implements ``del name``, where *namei* is the index into :attr:`co_names` - attribute of the code object. + Implements ``del name``, where *namei* is the index into :attr:`!co_names` + attribute of the :ref:`code object `. .. opcode:: UNPACK_SEQUENCE (count) @@ -897,7 +897,8 @@ iterations of the loop. value = STACK.pop() obj.name = value - where *namei* is the index of name in :attr:`co_names`. + where *namei* is the index of name in :attr:`!co_names` of the + :ref:`code object `. .. opcode:: DELETE_ATTR (namei) @@ -906,7 +907,8 @@ iterations of the loop. obj = STACK.pop() del obj.name - where *namei* is the index of name into :attr:`co_names`. + where *namei* is the index of name into :attr:`!co_names` of the + :ref:`code object `. .. opcode:: STORE_GLOBAL (namei) diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst index 4c2d03e..362ac75 100644 --- a/Doc/reference/datamodel.rst +++ b/Doc/reference/datamodel.rst @@ -1039,12 +1039,14 @@ A few types used internally by the interpreter are exposed to the user. Their definitions may change with future versions of the interpreter, but they are mentioned here for completeness. -.. index:: bytecode, object; code, code object +.. _code-objects: Code objects ^^^^^^^^^^^^ +.. index:: bytecode, object; code, code object + Code objects represent *byte-compiled* executable Python code, or :term:`bytecode`. The difference between a code object and a function object is that the function object contains an explicit reference to the function's globals (the module in diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index 2ba307d..13fc069 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -64,7 +64,6 @@ Doc/library/dbm.rst Doc/library/decimal.rst Doc/library/devmode.rst Doc/library/difflib.rst -Doc/library/dis.rst Doc/library/doctest.rst Doc/library/email.charset.rst Doc/library/email.compat32-message.rst -- cgit v0.12