Commit d8319f0f authored by Brad King's avatar Brad King
Browse files

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.
parent 50dca471
...@@ -521,14 +521,15 @@ Style: CMake Command Signatures ...@@ -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
^^^^^^^^^^^^^^^^
:: ::
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment