Skip to content

fixes gh-1880 recommend using *, then - in list-tables #2041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 9, 2021
Merged

fixes gh-1880 recommend using *, then - in list-tables #2041

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26f70f9
fixes gh-1880 recommend using *, then - in list-tables
Onvember Apr 9, 2021
f339b35
apply suggestions after review
Onvember Apr 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/contributing/docs/markup/_includes/table.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. container:: table

.. list-table::
:widths: 25 75
:header-rows: 1

* - Name
- Use

* - :doc:`/reference/reference_lua/box_ctl/wait_ro`
- Wait until ``box.info.ro`` is true
6 changes: 3 additions & 3 deletions doc/contributing/docs/markup/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Text can be organized in bullet-lists:

.. code-block:: rst

- This is a bullet list.
* This is a bullet list.

- Bullets can be "*", "+", or "-".
* Bullets can be "*", "+", or "-".

* Lists can be nested. And it is good to indent them with 4 spaces.
- Lists can be nested. And it is good to indent them with 4 spaces.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As for 4 space indent, I would suggest changing the wording and making it "a must" instead of "nice to have" as it says now. Because we have this in our doc guidelines https://www.tarantool.io/en/doc/latest/contributing/docs/markup/intro/#indentation

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it is necessary here)


or in enumerated lists:

Expand Down
16 changes: 8 additions & 8 deletions doc/contributing/docs/markup/tables.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Tables are very useful and rST markup
`offers <https://docutils.sourceforge.io/docs/ref/rst/directives.html#tables>`_
different ways to create them.

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

.. code-block:: rst
.. literalinclude:: _includes/table.rst
:language: rst

.. container:: table
This is how the table will look like:

.. list-table::
:widths: 25 75
:header-rows: 1
.. include:: _includes/table.rst

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