summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorErlend E. Aasland <erlend@python.org>2023-08-25 11:28:47 (GMT)
committerGitHub <noreply@github.com>2023-08-25 11:28:47 (GMT)
commitcb1184280b3fb369a07abb4153aa36829cf1df9b (patch)
tree100885e8acc2bbd7e5c6ce1703a88e503ff17c11 /Doc
parent2b7bff0655a4caf51cd1a9e5bf85b3b96dd031c9 (diff)
downloadcpython-cb1184280b3fb369a07abb4153aa36829cf1df9b.zip
cpython-cb1184280b3fb369a07abb4153aa36829cf1df9b.tar.gz
cpython-cb1184280b3fb369a07abb4153aa36829cf1df9b.tar.bz2
Docs: Resolve Sphinx warnings in dis.rst (#108476)
- Link to the code objects reference - Suppress link to deliberately undocumented builtins.__build_class__ - Suppress links for example methods
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/dis.rst20
-rw-r--r--Doc/reference/datamodel.rst4
-rw-r--r--Doc/tools/.nitignore1
3 files changed, 14 insertions, 11 deletions
diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst
index 7c3363b..6cd5f18 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::
@@ -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.
@@ -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)
@@ -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)
@@ -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)
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 832a915..cc81f73 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 bb5515b..953d10b 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -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