Skip to content

Commit

Permalink
Docs: Resolve Sphinx warnings in dis.rst (#108476)
Browse files Browse the repository at this point in the history
- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
  • Loading branch information
erlend-aasland committed Aug 25, 2023
1 parent 2b7bff0 commit cb11842
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 11 deletions.
20 changes: 11 additions & 9 deletions Doc/library/dis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down Expand Up @@ -862,7 +862,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.


Expand Down Expand Up @@ -920,14 +920,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 <code-objects>`.
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 <code-objects>`.


.. opcode:: UNPACK_SEQUENCE (count)
Expand Down Expand Up @@ -966,7 +966,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 <code-objects>`.

.. opcode:: DELETE_ATTR (namei)

Expand All @@ -975,7 +976,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 <code-objects>`.


.. opcode:: STORE_GLOBAL (namei)
Expand Down
4 changes: 3 additions & 1 deletion Doc/reference/datamodel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,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
Expand Down

0 comments on commit cb11842

Please sign in to comment.