mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 05:40:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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
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
cmake ``code-blocks``.
Signatures are separated from preceding content by a horizontal
line. That is, use:
Signatures are separated from preceding content by a section header.
That is, use:
.. code-block:: rst
... preceding paragraph.
---------------------------------------------------------------------
Normal Libraries
^^^^^^^^^^^^^^^^
::