From 0c3cadd21fc5a0d187eacbf4e1c8d5c1f001d2a8 Mon Sep 17 00:00:00 2001 From: root Date: Wed, 11 Oct 2017 07:48:07 +0000 Subject: [PATCH] Remove '``' (double backticks) from heading Change-Id: I72c7c6fb404863ae95b1f6638b8a4df50d1e9dff Closes-Bug: #1722718 --- doc/doc-contrib-guide/source/redirects.rst | 4 ++-- doc/doc-contrib-guide/source/writing-style/headings.rst | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/doc-contrib-guide/source/redirects.rst b/doc/doc-contrib-guide/source/redirects.rst index 7c94ff05db..c8eae55846 100644 --- a/doc/doc-contrib-guide/source/redirects.rst +++ b/doc/doc-contrib-guide/source/redirects.rst @@ -73,8 +73,8 @@ end up at the new home ``docs.openstack.org/nova/latest/user/cells.html``. .. _git-redirect-generation: -Optional: Generating ``.htaccess`` files from Git -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Optional: Generating .htaccess files from Git +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If creating an initial ``.htaccess``, you can use some Git-fu to automatically generate a file containing redirects between the last release and the current diff --git a/doc/doc-contrib-guide/source/writing-style/headings.rst b/doc/doc-contrib-guide/source/writing-style/headings.rst index dd2e6e95f4..b0e37659e0 100644 --- a/doc/doc-contrib-guide/source/writing-style/headings.rst +++ b/doc/doc-contrib-guide/source/writing-style/headings.rst @@ -23,6 +23,7 @@ Use the following guidelines for all types of headings: * Use articles in titles, but do not start the title with an article. * Avoid using uncommon abbreviations. * Do not end a title with a period or colon. +* Do not use double backticks(``) to highlight something. * Add some introductory text between two headings that go directly after each other.