[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [PATCH 5/5] docs: aesthetical cleanups



Removing "exempli gratia" when there should be dots afterwards, also
Uppercase letter should be present when starting a sentence.  Sorry
for the double line in the last hunk even though it's just adding a
word, but it would require to have new sentence starting on a newline
and that didn't seem very nice.
---
 docs/hacking.html.in | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 40acdbb..1363779 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -217,7 +217,7 @@
     <p>
       The keywords <code>if</code>, <code>for</code>, <code>while</code>,
       and <code>switch</code> must have a single space following them
-      before the opening bracket. eg
+      before the opening bracket. Example:
     </p>
     <pre>
       if(foo)   // Bad
@@ -226,7 +226,7 @@

     <p>
       Function implementations must <strong>not</strong> have any whitespace
-      between the function name and the opening bracket. eg
+      between the function name and the opening bracket. Example:
     </p>
     <pre>
       int foo (int wizz)  // Bad
@@ -235,7 +235,7 @@

     <p>
       Function calls must <strong>not</strong> have any whitespace
-      between the function name and the opening bracket. eg
+      between the function name and the opening bracket. Example:
     </p>
     <pre>
       bar = foo (wizz);  // Bad
@@ -245,7 +245,7 @@
     <p>
       Function typedefs must <strong>not</strong> have any whitespace
       between the closing bracket of the function name and opening
-      bracket of the arg list. eg
+      bracket of the arg list. Example:
     </p>
     <pre>
       typedef int (*foo) (int wizz);  // Bad
@@ -253,8 +253,8 @@
 </pre>

     <p>
-      There must not be any whitespace immediately following any
-      opening bracket, or immediately prior to any closing bracket
+      There must not be any whitespace immediately following any opening
+      bracket, or immediately prior to any closing bracket. Example:
     </p>
     <pre>
       int foo( int wizz );  // Bad
-- 
1.8.0.2


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]