mirror of
https://github.com/python/cpython.git
synced 2025-12-04 00:30:19 +00:00
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.
This commit is contained in:
parent
d91f8cf779
commit
16a57f6a34
21 changed files with 40 additions and 41 deletions
|
|
@ -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
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue