diff options
author | Georg Brandl <georg@python.org> | 2009-04-27 16:20:50 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2009-04-27 16:20:50 (GMT) |
commit | e720c0aa74ca8e6cf350b808c6ca795e587ebf88 (patch) | |
tree | d98ed50657772424243a590928333f96a61bb525 /Doc/documenting | |
parent | c67d362a89fe6076120f6de706725c313f515122 (diff) | |
download | cpython-e720c0aa74ca8e6cf350b808c6ca795e587ebf88.zip cpython-e720c0aa74ca8e6cf350b808c6ca795e587ebf88.tar.gz cpython-e720c0aa74ca8e6cf350b808c6ca795e587ebf88.tar.bz2 |
Merged revisions 72009 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r72009 | georg.brandl | 2009-04-27 17:29:09 +0200 (Mo, 27 Apr 2009) | 3 lines
Demote warnings to notices where appropriate, following the goal that as few "red box" warnings
should clutter the docs as possible. Part 1: stuff that gets merged to Py3k.
........
Diffstat (limited to 'Doc/documenting')
-rw-r--r-- | Doc/documenting/markup.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 9bb5193..3577c96 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -594,11 +594,11 @@ units as well as normal text: .. describe:: warning - An important bit of information about an API that a user should be very 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 differs from ``note`` in that it is recommended - over ``note`` for information regarding security. + 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. .. describe:: versionadded |