[docs] [issue17416] Documentation Ambiguity 2

Gurmeet Singh report at bugs.python.org
Thu Mar 14 10:43:01 CET 2013

New submission from Gurmeet Singh:

Source page: http://docs.python.org/3/library/os.html
Entry: os.walk(...)

Ambiguity Source: Name of the argument TopDown and / or its description.

The TopDown name is misleading to me. I would suggest BFS or DFS instead. TopDown false would imply to me that the traversal would run bottom up "from" the directory mentioned in the argument list (even though the name of that argument is top, it is confusing indicating a possibility of another naming mistake instead!)

assignee: docs at python
components: Documentation
messages: 184153
nosy: docs at python, gsingh
priority: normal
severity: normal
status: open
title: Documentation Ambiguity 2
type: enhancement
versions: Python 3.3

Python tracker <report at bugs.python.org>

More information about the docs mailing list