doc: Edits to the about.rst and simple.rst files.
Book titles need italics, other minor issues Line length fixed.
Markup errors corrected.
Resubmitted to solve merge issues.
Change-Id: I069463a45655e1bd4c57828008c0868083757344
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
diff --git a/doc/collaboration/documentation/about.rst b/doc/collaboration/documentation/about.rst
index 1413b01..2c1dd34 100644
--- a/doc/collaboration/documentation/about.rst
+++ b/doc/collaboration/documentation/about.rst
@@ -24,19 +24,23 @@
This style guide has two audiences:
-* Primary audience: Developers who author content that describes product function, code examples,
- procedures and more. Guidelines apply to human and machine generated content, such as APIs.
+* Primary audience: Developers who author content that describes product
+ function, code examples, procedures and more. Guidelines apply to human and
+ machine generated content, such as APIs.
-* Technical writers that wish to create technical documentation for the |project| (writers).
+* Technical writers that wish to create technical documentation for the
+ |project| (writers).
-* Secondary audience: Developers that wish to document their code and features (authors).
+* Secondary audience: Developers that wish to document their code and
+ features (authors).
Where the guideline makes a distinction for the two audiences, we will
refer to these groups as writers and authors.
.. note::
- As secondary audience, developers are not expected to master the style and writing guidelines
- in this document; it is available to them as a reference.
+ As secondary audience, developers are not expected to master the style and
+ writing guidelines in this document; it is available to them as a
+ reference.
Methodology
***********
diff --git a/doc/collaboration/documentation/simple.rst b/doc/collaboration/documentation/simple.rst
index 6e84c32..a3d72b1 100644
--- a/doc/collaboration/documentation/simple.rst
+++ b/doc/collaboration/documentation/simple.rst
@@ -112,14 +112,14 @@
Avoid nominalizations, which are nouns formed from verbs. For example:
===================== =====================
-Verbs Nominalizations
+Verbs Nominalizations
===================== =====================
-complete completion
-introduce introduction
-provide provision
-fail failure
-arrange arrangement
-install installation
+complete completion
+introduce introduction
+provide provision
+fail failure
+arrange arrangement
+install installation
===================== =====================
The problem with nominalizations is that they are often used instead of
