diff options
| author | Benjamin Peterson <benjamin@python.org> | 2009-09-17 03:27:33 (GMT) |
|---|---|---|
| committer | Benjamin Peterson <benjamin@python.org> | 2009-09-17 03:27:33 (GMT) |
| commit | 6fedc5252d21bc8d909b635baf7d73a44eb84364 (patch) | |
| tree | 30da6c559254f717c5c9561de59049bb8f5fa358 | |
| parent | 2348eda37bf37abb6a96a69301f4a3303d353f33 (diff) | |
| download | cpython-6fedc5252d21bc8d909b635baf7d73a44eb84364.zip cpython-6fedc5252d21bc8d909b635baf7d73a44eb84364.tar.gz cpython-6fedc5252d21bc8d909b635baf7d73a44eb84364.tar.bz2 | |
rationalize a bit
| -rw-r--r-- | Doc/documenting/markup.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 1d1023a..4c56cd2 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -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 |