[issue17417] Documentation Modification Suggestion: os.walk, fwalk
Gurmeet Singh added the comment: I am sorry to reopen this issue, if you do not like this comment, then I will reopen issues again. I am not saying to change the convention of the documentation - I just requested you to say something that would indicate that it is function that gives result in multiple calls. Mentioning the generator or iterator word would help a novice (but may not an expert like you) to understand that the object returned by this function needs to be called repeatedly and it does not return a collection of all results. After reading ... would be better floated on python-list, I do not know if my posting this comment would be termed as bugging? -- status: closed - open ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue17417 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue17417] Documentation Modification Suggestion: os.walk, fwalk
Terry J. Reedy added the comment: Reopening issues closed by a developer is worse than just 'bugging'. It wastes time, distracts from real problems, and if repeated can get your tracker account closed. Don't do it again. I gave you a suggestion: post on python-list where you can get responses from a variety of people. I read most of the original posts and some of the threads. When discussion indicates to me that there is a real problem, and has perhaps generated a solution, I have often either suggested that the original poster open an issue here or have done so myself. -- status: open - closed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue17417 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue17417] Documentation Modification Suggestion: os.walk, fwalk
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 rep...@bugs.python.org http://bugs.python.org/issue17417 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue17417] Documentation Modification Suggestion: os.walk, fwalk
New submission from Gurmeet Singh: Source page: http://docs.python.org/3/library/os.html Entry: os.walk(...), os.fwalk() These functions seems to be a generator functions. An expert like yourself may have no trouble to make this out. But for novice (or for people out of touch) like myself would have preferred a starting line of this function as A generator function that generates file names , rather than currently Generates file names -- assignee: docs@python components: Documentation messages: 184155 nosy: docs@python, gsingh priority: normal severity: normal status: open title: Documentation Modification Suggestion: os.walk, fwalk type: enhancement versions: Python 3.3 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue17417 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
