[Python-Dev] Warnings (original) (raw)
Georg Brandl g.brandl at gmx.net
Wed Dec 7 19:22:56 CET 2011
- Previous message: [Python-Dev] Warnings
- Next message: [Python-Dev] Warnings
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
Am 07.12.2011 02:23, schrieb Cameron Simpson:
On 30Nov2011 22:10, Raymond Hettinger <raymond.hettinger at 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,
Oh, come on, surely this doesn't effect the casual reader?
Georg
- Previous message: [Python-Dev] Warnings
- Next message: [Python-Dev] Warnings
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]