[New-bugs-announce] [issue9760] Suggestion for improving with documentation

Jason Baker report at bugs.python.org
Fri Sep 3 19:51:35 CEST 2010


New submission from Jason Baker <amnorvend at gmail.com>:

http://docs.python.org/reference/compound_stmts.html#with

This documentation refers to "context expressions" in two places.  However, it never really defines what a context expression is.  The formal syntax that's presented is this:

with_stmt ::=  "with" with_item ("," with_item)* ":" suite
with_item ::=  expression ["as" target]

As best I can tell, the context expression is essentially the with_item.  If that's the case, I propose one of the following:

 1) The formal syntax is changed so that "with_item" becomes "context_expression".
 2) References to "context expression" change to "with item".
 3) The "context expression" is defined to be the with_item in the formal syntax at some point in the documentation.

----------
assignee: docs at python
components: Documentation
messages: 115478
nosy: Jason.Baker, docs at python
priority: normal
severity: normal
status: open
title: Suggestion for improving with documentation
type: behavior
versions: Python 2.7

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


More information about the New-bugs-announce mailing list