openstack/openstack-manuals
Code Issues Proposed changes

[Contributor Guide] Update Code convention markup

Browse Source 
Indent the items so that this formats properly.
Also, ``markup`` inside of **markup** does not work, use single
quotation marks instead.

Change-Id: Iec2776929f14f114d7ae0132f5367347abc4d984
This commit is contained in:
Andreas Jaeger 2015-10-26 22:23:14 +01:00
parent 32ac624c24
commit 697a1dc553
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/contributor-guide/source/writing-style/code-conventions.rst
View File

@ -5,17 +5,17 @@ Code conventions
Follow these guidelines:
* **Do not use ``-y`` for package install**
* **Do not use "-y" for package install**
When you describe package installation, do not use the ``-y`` option.
Instead, use ``apt-get install package``, ``yum install package``, or
``zypper install package``.
When you describe package installation, do not use the ``-y`` option.
Instead, use ``apt-get install package``, ``yum install package``, or
``zypper install package``.
* **Use ``--option ARGUMENT``**
* **Use "--option ARGUMENT"**
The OpenStack CLI commands such as ``keystone`` support both
``--option ARGUMENT`` and ``--option=ARGUMENT``. In technical publications,
use ``--option ARGUMENT``.
The OpenStack CLI commands such as ``keystone`` support both
``--option ARGUMENT`` and ``--option=ARGUMENT``. In technical publications,
use ``--option ARGUMENT``.
.. note::