[issue11762] Ast doc: warning and version number

Terry J. Reedy report at bugs.python.org
Mon Apr 4 18:16:01 CEST 2011


New submission from Terry J. Reedy <tjreedy at udel.edu>:

Two related proposals.

1. Add a warning similar to the one for the dis module. As modified:

"CPython implementation detail: The ast definition is specific to the CPython interpreter! Ast nodes may be added, removed, or changed between versions. Use *ast.__version__* to work across versions."

I omitted " Use of this module should not be considered to work across Python VMs or Python releases." as redundant and too legalistic.
*ast.__version__* should link to its (new) entry).

2. Add a full entry for __version__. Currently (3.2):

"The module defines a string constant __version__ which is the decimal Subversion revision number of the file shown below."

Proposed replacement (with hidden reference point):

ast.__version__         [__version__ in normal entry boldface]
    String constant with version number of abstract grammar file.
    3.1: 67616; 3.2: 82163; 3.3: xxxxxxxxx

----------
assignee: docs at python
components: Documentation
messages: 132951
nosy: docs at python, terry.reedy
priority: normal
severity: normal
stage: needs patch
status: open
title: Ast doc: warning and version number
versions: Python 2.7, Python 3.2, Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue11762>
_______________________________________


More information about the Python-bugs-list mailing list