[Python-checkins] r83012 - in python/branches/release31-maint: Doc/library/dis.rst Misc/NEWS

brett.cannon python-checkins at python.org
Wed Jul 21 11:50:42 CEST 2010


Author: brett.cannon
Date: Wed Jul 21 11:50:42 2010
New Revision: 83012

Log:
Backport r82456


Modified:
   python/branches/release31-maint/Doc/library/dis.rst
   python/branches/release31-maint/Misc/NEWS

Modified: python/branches/release31-maint/Doc/library/dis.rst
==============================================================================
--- python/branches/release31-maint/Doc/library/dis.rst	(original)
+++ python/branches/release31-maint/Doc/library/dis.rst	Wed Jul 21 11:50:42 2010
@@ -5,12 +5,18 @@
    :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.
 
+.. impl-detail::
+
+   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):

Modified: python/branches/release31-maint/Misc/NEWS
==============================================================================
--- python/branches/release31-maint/Misc/NEWS	(original)
+++ python/branches/release31-maint/Misc/NEWS	Wed Jul 21 11:50:42 2010
@@ -363,6 +363,12 @@
 - Issue #8193: Fix test_zlib failure with zlib 1.2.4.
 
 
+Documentation
+-------------
+
+- Issue #7829: Document in dis that bytecode is an implementation detail.
+
+
 What's New in Python 3.1.2?
 ===========================
 


More information about the Python-checkins mailing list