[Python-checkins] r74863 - python/trunk/Doc/documenting/markup.rst

benjamin.peterson python-checkins at python.org
Thu Sep 17 05:27:33 CEST 2009


Author: benjamin.peterson
Date: Thu Sep 17 05:27:33 2009
New Revision: 74863

Log:
rationalize a bit

Modified:
   python/trunk/Doc/documenting/markup.rst

Modified: python/trunk/Doc/documenting/markup.rst
==============================================================================
--- python/trunk/Doc/documenting/markup.rst	(original)
+++ python/trunk/Doc/documenting/markup.rst	Thu Sep 17 05:27:33 2009
@@ -597,8 +597,10 @@
    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
 


More information about the Python-checkins mailing list