Browse Source

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.
Brad King 11 years ago
parent
commit
d8319f0fc9
1 changed files with 4 additions and 3 deletions
  1. 4 3
      Help/manual/cmake-developer.7.rst

+ 4 - 3
Help/manual/cmake-developer.7.rst

@@ -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
+  ^^^^^^^^^^^^^^^^
 
   ::