[docs] [issue17417] Documentation Modification Suggestion: os.walk, fwalk

Terry J. Reedy report at bugs.python.org
Fri Mar 15 23:18:40 CET 2013

Terry J. Reedy added the comment:

Our standard is to start function doc entries with verbs. In any case, it is irrelevant whether os.walk is a generator function or iterator class. Which is to say, it is not part of the language definition that the object returned by os.walk() is specifically a generator, as opposed to an instance of some other iterator class. Indeed, other implementations might do differently and if we decided to recode os.walk in C to make it faster, it would be an iterator class and not a generator function (which are only written in Python). So 'generate' is being used in a generic sense. 

Ideas like this, and the one about changing 'topdown', would be better floated on python-list.

nosy: +terry.reedy
resolution:  -> works for me
stage:  -> committed/rejected
status: open -> closed

Python tracker <report at bugs.python.org>

More information about the docs mailing list