kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Help: Update style guide to use section headers for command signatures 

In order to be able to link to specific command signatures we need to
use a section header instead of a horizontal separator.
This commit is contained in:
Brad King 2014-06-12 13:54:27 -04:00
parent 50dca47106
commit d8319f0fc9
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Help/manual/cmake-developer.7.rst
View File

@ -521,14 +521,15 @@ Style: CMake Command Signatures
Command signatures should be marked up as plain literal blocks, not as Command signatures should be marked up as plain literal blocks, not as
cmake ``code-blocks``. cmake ``code-blocks``.
Signatures are separated from preceding content by a horizontal Signatures are separated from preceding content by a section header.
line. That is, use: That is, use:
.. code-block:: rst .. code-block:: rst
... preceding paragraph. ... preceding paragraph.
--------------------------------------------------------------------- Normal Libraries
^^^^^^^^^^^^^^^^
:: ::