[New-bugs-announce] [issue13677] correct docstring for builtin compile

[Jim Jewett]

New submission from Jim Jewett <jimjjewett at gmail.com>:

The current docstring for compile suggests that the flags are strictly for selecting future statements.  These are not the only flags.

It also suggests that the source must be source code and the result will be bytecode, which isn't quite true.

I suggest changing:

"The flags argument, if present, controls which future statements influence the compilation of the code."

to:

"The flags argument, if present, largely controls which future 
statements influence the compilation of the code.  (Additional 
flags are documented in the AST module.)"

----------
assignee: docs at python
components: Documentation
files: bltinmodule.c.patch
keywords: patch
messages: 150337
nosy: Jim.Jewett, docs at python
priority: normal
severity: normal
status: open
title: correct docstring for builtin compile
type: behavior
Added file: http://bugs.python.org/file24105/bltinmodule.c.patch

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