[Python-Dev] Warnings

[Tres Seaver]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 12/07/2011 01:22 PM, Georg Brandl wrote:
> 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?

/me presumes an ironic mispeling there. ;)


Tres.
- -- 
===================================================================
Tres Seaver          +1 540-429-0999          tseaver at palladion.com
Palladion Software   "Excellence by Design"    http://palladion.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk7fyZgACgkQ+gerLs4ltQ5eaQCeL+E4CVxa1BWhm/MsPw29u/Ym
QnUAoKBOY37dNA9aT5TZkv4hu9ixZjBn
=jg86
-----END PGP SIGNATURE-----