openstack/openstack-manuals
Code Issues Proposed changes

[contributor] Change RST inline markup conventions

Browse Source 
:program:` ` markup is not widely used at our docs.
This convention become an inconsistency.
Also, this markup doesn't help translators.

Some discussion on docs mailing list:
http://lists.openstack.org/pipermail/openstack-docs/2015-November/007892.html

Change-Id: I7efd24efc626ebfc5d73a2f23a1ee5e7ddfc00a4
This commit is contained in:
KATO Tomoyuki
2015-11-18 23:59:47 +09:00
parent 108a376399
commit ce81edc685
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/contributor-guide/source/rst-conv/inline-markups.rst
View File

@@ -30,11 +30,11 @@ Application
A software application within a line of text.
+------------------------+---------------------------------------------------+
| **Markup** | ``:program:`` |
| **Markup** | `````` (double backticks) |
+------------------------+---------------------------------------------------+
| **Syntax** | ``:program:`RabbitMQ``` |
| **Syntax** | ````RabbitMQ```` |
+------------------------+---------------------------------------------------+
| **Example of output** | Configure :program:`RabbitMQ`. |
| **Example of output** | Configure ``RabbitMQ``. |
+------------------------+---------------------------------------------------+
Code