]> granicus.if.org Git - python/commitdiff
rationalize a bit
authorBenjamin Peterson <benjamin@python.org>
Thu, 17 Sep 2009 03:27:33 +0000 (03:27 +0000)
committerBenjamin Peterson <benjamin@python.org>
Thu, 17 Sep 2009 03:27:33 +0000 (03:27 +0000)
Doc/documenting/markup.rst

index 1d1023a5d13d9d3e7c15c0b618734724083cd303..4c56cd216518517cc56a51b56dfaf2d6b971c1c9 100644 (file)
@@ -597,8 +597,10 @@ units as well as normal text:
    An important bit of information about an API that a user should be aware of
    when using whatever bit of API the warning pertains to.  The content of the
    directive should be written in complete sentences and include all appropriate
-   punctuation.  This should only be chosen over ``note`` for information
-   regarding the possibility of crashes, data loss, or security implications.
+   punctuation.  In the interest of not scaring users away from pages filled
+   with warnings, this directive should only be chosen over ``note`` for
+   information regarding the possibility of crashes, data loss, or security
+   implications.
 
 .. describe:: versionadded