diff options
| author | Georg Brandl <georg@python.org> | 2009-04-28 18:23:28 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-04-28 18:23:28 (GMT) |
| commit | 3885314b116d20c86d52701c2c4e7f9492f90c3c (patch) | |
| tree | bb984633a0a3170afc41a2dbe4bfa75cadde6ef0 /Doc/documenting | |
| parent | 9ba8e571c18d371ce4c12cffeac5523de9d97012 (diff) | |
| download | cpython-3885314b116d20c86d52701c2c4e7f9492f90c3c.zip cpython-3885314b116d20c86d52701c2c4e7f9492f90c3c.tar.gz cpython-3885314b116d20c86d52701c2c4e7f9492f90c3c.tar.bz2 | |
Merged revisions 72007-72010,72036-72037 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r72007 | georg.brandl | 2009-04-27 17:09:25 +0200 (Mo, 27 Apr 2009) | 1 line
#5856: fix typo s in traceback example.
........
r72008 | georg.brandl | 2009-04-27 17:10:44 +0200 (Mo, 27 Apr 2009) | 1 line
Remove ".. warning::" markup that doesnt contain warnings for users, rather todo items.
........
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.
........
r72010 | georg.brandl | 2009-04-27 17:29:26 +0200 (Mo, 27 Apr 2009) | 2 lines
Demote warnings to notices, part 2: stuff that is 2.x-only.
........
r72036 | georg.brandl | 2009-04-27 19:04:23 +0200 (Mo, 27 Apr 2009) | 1 line
#5848: small unittest doc patch.
........
r72037 | georg.brandl | 2009-04-27 19:09:53 +0200 (Mo, 27 Apr 2009) | 1 line
#5840: dont claim we dont support TLS.
........
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 3ca8983..1d1023a 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 |