openstack/openstack-manuals
Code Issues Proposed changes

[contributor] Emphasize Preferred word choices

Browse Source 
To improve the readability.

Change-Id: Iaa5420a4fad9c48aa2af8046d80f3c6d8ab4e99e
This commit is contained in:
KATO Tomoyuki
2016-01-22 07:17:40 +09:00
parent ec95ab4832
commit e0acee6238
1 changed files with 68 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

114
doc/contributor-guide/source/writing-style/word-choice.rst
View File

@@ -15,71 +15,71 @@ The following table lists the preferred word or phrase choice.
**Preferred word choice** **Preferred word choice**
+----------------+----------------------+ +---------------------+----------------------+
| **Word** | **Do not use** | | **Word** | **Do not use** |
+================+======================+ +=====================+======================+
| and so on | etc. | | **and so on** | etc. |
+----------------+----------------------+ +---------------------+----------------------+
| back end (noun)| backend, back-end | | **back end (noun)** | backend, back-end |
| | | | | |
| | In general, avoid. | | | In general, avoid. |
| | Use a more specific | | | Use a more specific |
| | term, such as | | | term, such as |
| | server, operating | | | server, operating |
| | system, or network. | | | system, or network. |
+----------------+----------------------+ +---------------------+----------------------+
| back-end (adj) | backend, back end | | **back-end (adj)** | backend, back end |
+----------------+----------------------+ +---------------------+----------------------+
| cancel | abort | | **cancel** | abort |
| | | | | |
+----------------+----------------------+ +---------------------+----------------------+
| complete | done, finish | | **complete** | done, finish |
+----------------+----------------------+ +---------------------+----------------------+
| command line | command-line | | **command line | command-line |
| (noun) | | | (noun)** | |
+----------------+----------------------+ +---------------------+----------------------+
| command-line | command line | | **command-line | command line |
| (adj) | | | (adj)** | |
+----------------+----------------------+ +---------------------+----------------------+
| data store | datastore | | **data store** | datastore |
+----------------+----------------------+ +---------------------+----------------------+
| delete | destroy | | **delete** | destroy |
+----------------+----------------------+ +---------------------+----------------------+
| to do something| in order to do | | **to do something** | in order to do |
| | something | | | something |
+----------------+----------------------+ +---------------------+----------------------+
| Ethernet | ethernet | | **Ethernet** | ethernet |
+----------------+----------------------+ +---------------------+----------------------+
| example | i.e, e.g. | | **example** | i.e, e.g. |
+----------------+----------------------+ +---------------------+----------------------+
| host name | hostname, Hostname | | **host name** | hostname, Hostname |
+----------------+----------------------+ +---------------------+----------------------+
| lifecycle | life cycle | | **lifecycle** | life cycle |
+----------------+----------------------+ +---------------------+----------------------+
| login (noun) | logon, log-in | | **login (noun)** | logon, log-in |
+----------------+----------------------+ +---------------------+----------------------+
| log in (verb) | login | | **log in (verb)** | login |
+----------------+----------------------+ +---------------------+----------------------+
| OpenStack | openstack, Openstack | | **OpenStack** | openstack, Openstack |
+----------------+----------------------+ +---------------------+----------------------+
| plug-in | plugin | | **plug-in** | plugin |
+----------------+----------------------+ +---------------------+----------------------+
| run, issue, | Avoid using "execute"| | **run, issue, | Avoid using "execute"|
| start, enter | unless it is the most| | start, enter** | unless it is the most|
| | appropriate term in | | | appropriate term in |
| | the context. | | | the context. |
+----------------+----------------------+ +---------------------+----------------------+
| select | check | | **select** | check |
+----------------+----------------------+ +---------------------+----------------------+
| setup (noun) | set up, set-up | | **setup (noun)** | set up, set-up |
+----------------+----------------------+ +---------------------+----------------------+
| set up (verb) | setup | | **set up (verb)** | setup |
+----------------+----------------------+ +---------------------+----------------------+
| an SQL | a SQL | | **an SQL** | a SQL |
+----------------+----------------------+ +---------------------+----------------------+
| such as | like | | **such as** | like |
+----------------+----------------------+ +---------------------+----------------------+
| verify | be sure | | **verify** | be sure |
+----------------+----------------------+ +---------------------+----------------------+
| X-as-a-Service | X as a Service | | **X-as-a-Service** | X as a Service |
+----------------+----------------------+ +---------------------+----------------------+