summaryrefslogtreecommitdiffstats
path: root/Doc/library/dis.rst
diff options
context:
space:
mode:
authorBrett Cannon <bcannon@gmail.com>2010-07-02 22:03:00 (GMT)
committerBrett Cannon <bcannon@gmail.com>2010-07-02 22:03:00 (GMT)
commit8315fd12a5a5dd612fecd12677a01c1b06d5b71d (patch)
tree51449dbd858e97c0e18265581db2e77e25eadb65 /Doc/library/dis.rst
parentbe5846bfdc90bb4216a179dcc3ced11bf4aaaf8c (diff)
downloadcpython-8315fd12a5a5dd612fecd12677a01c1b06d5b71d.zip
cpython-8315fd12a5a5dd612fecd12677a01c1b06d5b71d.tar.gz
cpython-8315fd12a5a5dd612fecd12677a01c1b06d5b71d.tar.bz2
Some people have mistaken Python bytecode as being stable and unchanging. In
reality it's simply an implementation detail for CPython. This point is now clearly documented in both the docs for dis and the glossary. Closes issue #7829. Thanks to Terry Reedy for some initial suggestions on wording.
Diffstat (limited to 'Doc/library/dis.rst')
-rw-r--r--Doc/library/dis.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst
index b62a673..c9417ea 100644
--- a/Doc/library/dis.rst
+++ b/Doc/library/dis.rst
@@ -5,12 +5,13 @@
:synopsis: Disassembler for Python bytecode.
-The :mod:`dis` module supports the analysis of Python :term:`bytecode` by
-disassembling it. Since there is no Python assembler, this module defines the
-Python assembly language. The Python bytecode which this module takes as an
+The :mod:`dis` module supports the analysis of CPython :term:`bytecode` by
+disassembling it. The CPython bytecode which this module takes as an
input is defined in the file :file:`Include/opcode.h` and used by the compiler
and the interpreter.
+.. warning:: Bytecode is an implementation detail of the CPython interpreter! No guarantees are made that bytecode will not be added, removed, or changed between versions of Python. Use of this module should not be considered to work across Python VMs or Python releases.
+
Example: Given the function :func:`myfunc`::
def myfunc(alist):