Skip to content

Commit 1a699d7

Browse files
xuniqNickVolynkin
andauthored
Update the Admonitions section (#2348)
Add the `important::` directive to the Admonitions section Co-authored-by: Nick Volynkin <nick.volynkin@gmail.com>
1 parent 21f0205 commit 1a699d7

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/contributing/docs/markup/admonitions.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,19 @@ In Tarantool we have 3 variants of css-style for admonitions:
3434
For example, in the description of :doc:`/reference/reference_lua/box_session/on_connect`
3535
trigger we warn a user about some consequences of his actions.
3636

37+
* Important:
38+
39+
.. code-block:: rst
40+
41+
.. important::
42+
43+
.. important::
44+
45+
This block contains essential information that the user should know while doing something.
46+
47+
For example, the block :doc:`in Getting Started with Docker </getting_started/getting_started_go>` is used to warn the user against
48+
closing the terminal window.
49+
3750
* Custom admonition:
3851

3952
.. code-block:: rst

0 commit comments

Comments
 (0)