diff options
| author | Brad King <brad.king@kitware.com> | 2014-06-12 17:54:27 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-06-12 17:57:36 (GMT) |
| commit | d8319f0fc99fb628cbe33c3cc9169c2bd3a97f40 (patch) | |
| tree | 404ae728f6fa0a4534105e68b5c301e1c492722f /Help | |
| parent | 50dca47106a17fe9a4a929243fd12f84d4f95e79 (diff) | |
| download | CMake-d8319f0fc99fb628cbe33c3cc9169c2bd3a97f40.zip CMake-d8319f0fc99fb628cbe33c3cc9169c2bd3a97f40.tar.gz CMake-d8319f0fc99fb628cbe33c3cc9169c2bd3a97f40.tar.bz2 | |
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.
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-developer.7.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 9851c12..cd979c9 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/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 + ^^^^^^^^^^^^^^^^ :: |