@@ -94,11 +94,11 @@ Titles
- Use the following headers levels.
- | ======= Heading 0 (reserved for the title in a document)
- | ------- Heading 1
- | ~~~~~~~ Heading 2
- | +++++++ Heading 3
- | ''''''' Heading 4
+ | ``=======`` Heading 0 (reserved for the title in a document)
+ | ``-------`` Heading 1
+ | ``~~~~~~~`` Heading 2
+ | ``+++++++`` Heading 3
+ | ``'''''''`` Heading 4
.. note::
@@ -279,7 +279,7 @@ vSwitch documentation. These guidelines are based on the `IBM Style Guide
Commonly used terms like CPU or RAM are allowed.
- .. list-table:: Example
+ .. list-table::
:header-rows: 1
* - Do not use
@@ -293,7 +293,7 @@ vSwitch documentation. These guidelines are based on the `IBM Style Guide
The subject should do the verb's action, rather than be acted upon.
- .. list-table:: Example
+ .. list-table::
:header-rows: 1
* - Do not use
@@ -303,7 +303,7 @@ vSwitch documentation. These guidelines are based on the `IBM Style Guide
- Write in the present tense
- .. list-table:: Example
+ .. list-table::
:header-rows: 1
* - Do not use
@@ -313,7 +313,7 @@ vSwitch documentation. These guidelines are based on the `IBM Style Guide
- Write in second person
- .. list-table:: Example
+ .. list-table::
:header-rows: 1
* - Do not use
The table headers are unnecessary and make the doc harder to read, while the headers guide was not displaying very well. Signed-off-by: Stephen Finucane <stephen@that.guru> --- .../internals/contributing/documentation-style.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)