note

See also

• http://sphinx-doc.org/latest/markup/para.html?highlight=note#directive-note

An especially important bit of information about an API that a user should be aware of when using whatever bit of API the note pertains to. The content of the directive should be written in complete sentences and include all appropriate punctuation.

Example:

.. note::

   This function is not suitable for sending spam e-mails.

Note

This function is not suitable for sending spam e-mails.