diff options
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 |