[issue18796] Wrong documentation of show_code function from dis module
New submission from Vajrasky Kok: $ ./python Python 3.4.0a1+ (default:afb1b4797419, Aug 21 2013, 09:54:46) [GCC 4.7.2] on linux Type "help", "copyright", "credits" or "license" for more information.
import dis import sys def spam(x): ... return x * 2 ... dis.show_code(spam, file=sys.stderr) Name: spam Filename: <stdin> Argument count: 1 Kw-only arguments: 0 Number of locals: 1 Stack size: 2 Flags: OPTIMIZED, NEWLOCALS, NOFREE Constants: 0: None 1: 2 Variable names: 0: x output = open('/tmp/output.txt', 'w') dis.show_code(spam, file=output) output.close() dis.show_code.__doc__ 'Print details of methods, functions, or code to stdout.'
Attached the patch to fix the documentation. ---------- assignee: docs@python components: Documentation files: fix_doc_show_code.patch keywords: patch messages: 195742 nosy: docs@python, vajrasky priority: normal severity: normal status: open title: Wrong documentation of show_code function from dis module versions: Python 3.4 Added file: http://bugs.python.org/file31392/fix_doc_show_code.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18796> _______________________________________
Roundup Robot added the comment: New changeset 64678369c4d0 by Ezio Melotti in branch 'default': #18796: improve documentation of the file argument of dis.show_code. Initial patch by Vajrasky Kok. http://hg.python.org/cpython/rev/64678369c4d0 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18796> _______________________________________
Ezio Melotti added the comment: Fixed, thanks for the report and the patch! ---------- assignee: docs@python -> ezio.melotti nosy: +ezio.melotti resolution: -> fixed stage: -> committed/rejected status: open -> closed type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18796> _______________________________________
participants (3)
-
Ezio Melotti
-
Roundup Robot
-
Vajrasky Kok