diff options
| author | Stephen Finucane <stephen@that.guru> | 2016-12-17 22:23:38 +0000 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2016-12-21 13:38:45 -0800 |
| commit | 36c96690c919e77a7d642f533658e0851163f155 (patch) | |
| tree | 15952bd25cdabd709dc4bcd40239f08207cc7f1c /Documentation/internals | |
| parent | 945535044eedbbe913949d32cf6ba43463af507b (diff) | |
| download | openvswitch-36c96690c919e77a7d642f533658e0851163f155.tar.gz | |
doc: Misc fixes to 'documentation-style'
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>
Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/internals')
| -rw-r--r-- | Documentation/internals/contributing/documentation-style.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index a3149ba6d..3c04b867f 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -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:: @@ -280,7 +280,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 @@ -294,7 +294,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 @@ -304,7 +304,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 @@ -314,7 +314,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 |