Skip to content

Commit cc7cc45

Browse files
authored
fixes gh-1880 recommend using *, then - in list-tables (#2041)
* fixes gh-1880 recommend using *, then - in list-tables * apply suggestions after review
1 parent 271edf6 commit cc7cc45

File tree

3 files changed

+22
-11
lines changed

3 files changed

+22
-11
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. container:: table
2+
3+
.. list-table::
4+
:widths: 25 75
5+
:header-rows: 1
6+
7+
* - Name
8+
- Use
9+
10+
* - :doc:`/reference/reference_lua/box_ctl/wait_ro`
11+
- Wait until ``box.info.ro`` is true

doc/contributing/docs/markup/intro.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Text can be organized in bullet-lists:
1111

1212
.. code-block:: rst
1313
14-
- This is a bullet list.
14+
* This is a bullet list.
1515
16-
- Bullets can be "*", "+", or "-".
16+
* Bullets can be "*", "+", or "-".
1717
18-
* Lists can be nested. And it is good to indent them with 4 spaces.
18+
- Lists can be nested. And it is good to indent them with 4 spaces.
1919
2020
or in enumerated lists:
2121

doc/contributing/docs/markup/tables.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ Tables are very useful and rST markup
55
`offers <https://docutils.sourceforge.io/docs/ref/rst/directives.html#tables>`_
66
different ways to create them.
77

8-
We prefer list-tables to create table of contents:
8+
We prefer list-tables because they allow you to put as much content as you need
9+
without painting ASCII-style borders:
910

10-
.. code-block:: rst
11+
.. literalinclude:: _includes/table.rst
12+
:language: rst
1113

12-
.. container:: table
14+
This is how the table will look like:
1315

14-
.. list-table::
15-
:widths: 25 75
16-
:header-rows: 1
16+
.. include:: _includes/table.rst
1717

18-
* - Name
19-
- Use
18+
Notice that we use ``*`` and then ``-`` in tables because it is more readable
19+
when rows and columns marked differently.

0 commit comments

Comments
 (0)