zephyr/doc/documentation/detailed_parallelism.rst
Rodrigo Caballero c94fc1ee60 Add detailed documentation guidelines.
The guidelines include information regarding: lists, modular writing,
notices, parallelism and simple English.

Also includes the capitalization, punctuation and spelling conventions
for the project.

Change-Id: I754f492db41dc5cc2432d03441b0526603b043e6
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:14:27 -05:00

33 lines
1.8 KiB
ReStructuredText

.. _parallelism:
Parallelism
###########
Parallelism refers to the practice of using similar patterns of
grammatical structure, and sometimes length, for coordinated words,
phrases, and clauses.
Parallel construction is especially important in bulleted lists. The
table shows some unparallel structures and how they can be made
parallel with a little rewording.
+----------------------------------+----------------------------------+
| Parallel (do) | Unparallel (don't) |
+==================================+==================================+
| 1. Mount the panel. | 1. Mount the panel. |
| 2. Install the battery. | 2. Battery installation. |
| 3. Wire the keypad. | 3. Wiring the keypad. |
+----------------------------------+----------------------------------+
| The system sends a message to | The system sent a message to the |
| the call center, which calls the | call center, which calls the |
| customer and tells about the | customer and will tell about the |
| burglary. | burglary. |
+----------------------------------+----------------------------------+
| The system tried to send alarm | The system tried to send alarm |
| messages that were precise and | messages that had precision and |
| accurate. | were accurate. |
+----------------------------------+----------------------------------+
| You need to install the panel, | You need to install the panel, |
| wire the sensors, and test the | wire the sensors, and you |
| phone line. | must test the phone line. |
+----------------------------------+----------------------------------+