On 30Nov2011 22:10, Raymond Hettinger <raymond.hettin...@gmail.com> wrote: | When updating the documentation, please don't go overboard with warnings. | The docs need to be worded affirmatively -- say what a tool does and show how to use it correctly. | See http://docs.python.org/documenting/style.html#affirmative-tone
I come to this late, but if we're going after the docs... At the above link one finds this text: This assures that files are flushed [...] It does not. It _ensures_ that files are flushed. The doco style "affirmative tone" _assures_. The coding practice _ensures_! Pedanticly, -- Cameron Simpson <c...@zip.com.au> DoD#743 http://www.cskk.ezoshosting.com/cs/ There is one evil which...should never be passed over in silence but be continually publicly attacked, and that is corruption of the language... - W.H. Auden _______________________________________________ Python-Dev mailing list Python-Dev@python.org http://mail.python.org/mailman/listinfo/python-dev Unsubscribe: http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com
