openstack-manuals/doc/contributor-guide/source/rst-conv/comment.rst
KATO Tomoyuki f06e866917 [contributor] reorganize RST/JSON conventions
Change-Id: Idac1e6c049438819d5c363b694102c22d67fa19b
Implements: blueprint contributor-guide-reorg
2016-07-12 14:42:50 +00:00

18 lines
411 B
ReStructuredText

========
Comments
========
Indicate a comment by means of the ``..`` marker.
**Input**
.. code-block:: none
.. This is a comment. It is not visible in the documentation build.
Generally, use it to include TODO within the content followed
by the initials of the person who is to perform the action.
For example:
.. TODO(OG): add a link to the Decorations section when it is available.