Docs Update

Author: AsnelChristian

README.rst

@@ -44,9 +44,6 @@ The aspect tree is given below:
     - `TrailingSpace <Root/Formatting/Spacing/TrailingSpace/README.rst>`_ 
 
 
-    - `UseSpaces <Root/Formatting/Spacing/UseSpaces/README.rst>`_ 
-      
-
 - `Metadata <Root/Metadata/README.rst>`_ 
 
 
@@ -167,21 +164,9 @@ The aspect tree is given below:
 - `Spelling <Root/Spelling/README.rst>`_ 
 
 
-  - `CompanySpecificWordSpelling <Root/Spelling/CompanySpecificWordSpelling/README.rst>`_ 
-    
-
-  - `GeneralWordSpelling <Root/Spelling/GeneralWordSpelling/README.rst>`_ 
-    
-
-- `Syntax <Root/Syntax/README.rst>`_ 
-  
-
-  - `Context <Root/Syntax/Context/README.rst>`_ 
-    
-
-  - `KeyWords <Root/Syntax/KeyWords/README.rst>`_ 
+  - `DictionarySpelling <Root/Spelling/DictionarySpelling/README.rst>`_ 
 
 
-  - `Phrases <Root/Syntax/Phrases/README.rst>`_ 
+  - `OrgSpecificWordSpelling <Root/Spelling/OrgSpecificWordSpelling/README.rst>`_ 
 
 

Root/Formatting/Length/FileLength/README.rst

@@ -8,7 +8,7 @@
 
 FileLength
 ==========
-A file's length refers to number of character found in it.
+Number of lines found in a file.
 
 Tastes
 ========
@@ -32,16 +32,16 @@ This aspect does not have any sub aspects.
 Example
 =======
 
-.. code-block:: python
+.. code-block:: Python 3
 
     # This file would be a large file if we assume that the max number of
     # lines per file is 10
 
-    class node:
-        def __init__(self, value, leftmostchild, leftsibling):
+    class Node:
+        def __init__(self, value, left_most_child, left_sibling):
             self.value=value
-            self.leftmostchild=leftmostchild
-            self.leftsibling=leftsibling
+            self.left_most_child=left_most_child
+            self.left_sibling=left_sibling
 
     # This is example is just showing what this aspect is about, because
     # the max number of lines per file is usually 999.

Root/Formatting/Length/LineLength/README.rst

@@ -8,7 +8,7 @@
 
 LineLength
 ==========
-A line's length refers to the number of character found in it.
+Number of characters found in a line of code.
 
 Tastes
 ========
@@ -47,5 +47,5 @@ How to fix this
 
 Splitting long lines of code into multiple shorter lines whenever
 possible. Avoiding the usage of in-line language specific constructs
-whenever they results in too long lines.
+whenever they result in too long lines.
 

Root/Formatting/Length/README.rst

@@ -8,10 +8,7 @@
 
 Length
 ======
-The `Length` here refers to:
-
-    * each line's length in the file,
-    * the file length.
+Hold sub-aspects for file and line length.
 
 Subaspects
 ==========
@@ -21,7 +18,7 @@ Subaspects
 Example
 =======
 
-.. code-block:: python
+.. code-block:: Python
 
     # We assume that the maximum number of characters per line is 10
     # and that the maximum number of lines per files is 3.
@@ -39,7 +36,7 @@ read, understand and maintain.
 How to fix this
 ==========
 
-Length issues can be fixed by writing shorter lines of code(splitting
-long lines into multiple shorter lines); writing shorter files(
-splitting files into modules, writing shorter methods and classes.).
+Length issues can be fixed by writing shorter lines of code (splitting
+long lines into multiple shorter lines); writing shorter files
+(splitting files into modules, writing shorter methods and classes.).
 

Root/Formatting/Quotation/README.rst

@@ -8,7 +8,7 @@
 
 Quotation
 =========
-Determines the quotations' marks used for strings and *docs*.
+Quotation mark used for strings and docstrings.
 
 Tastes
 ========
@@ -32,7 +32,7 @@ This aspect does not have any sub aspects.
 Example
 =======
 
-.. code-block:: python
+.. code-block:: Python
 
     # Here is an example of code where both '' and "" quotation mark
     # Are used.
@@ -44,7 +44,7 @@ Example
 Importance
 ==========
 
-Using the same quotation (if possible) in a code, improve on its
+Using the same quotation whenever possible in the code, improve on its
 readability by introducing consistency.
 
 How to fix this

Root/Formatting/README.rst

@@ -2,13 +2,13 @@
 | ``Root.Formatting`` | `Parent <../README.rst>`_  | `Index <//github.com/coala/aspect-docs/blob/master/README.rst>`_ |
 +---------------------+----------------------------+------------------------------------------------------------------+
 
-+---------------------+--------------------------------------+------------------------------------------+--------------------------------------+--------------------------------+--------------------------------------+----------------------------------+
-| **Sibling aspects** | `Metadata <../Metadata/README.rst>`_ | `Redundancy <../Redundancy/README.rst>`_ | `Security <../Security/README.rst>`_ | `Smell <../Smell/README.rst>`_ | `Spelling <../Spelling/README.rst>`_ | `Syntax <../Syntax/README.rst>`_ |
-+---------------------+--------------------------------------+------------------------------------------+--------------------------------------+--------------------------------+--------------------------------------+----------------------------------+
++---------------------+--------------------------------------+------------------------------------------+--------------------------------------+--------------------------------+--------------------------------------+
+| **Sibling aspects** | `Metadata <../Metadata/README.rst>`_ | `Redundancy <../Redundancy/README.rst>`_ | `Security <../Security/README.rst>`_ | `Smell <../Smell/README.rst>`_ | `Spelling <../Spelling/README.rst>`_ |
++---------------------+--------------------------------------+------------------------------------------+--------------------------------------+--------------------------------+--------------------------------------+
 
 Formatting
 ==========
-Formatting refers to the visual appearance of source code.
+The visual appearance of source code.
 
 Subaspects
 ==========
@@ -19,14 +19,14 @@ Subaspects
 Example
 =======
 
-.. code-block:: python
+.. code-block:: Python
 
-    # Here is an example of python code with lots of
+    # Here is an example of Python code with lots of
     # formatting issues including: trailing spaces, missing spaces
     # around operators, strange and inconsistent indentation etc.
     
     z = 'hello'+'world'
-         def f ( a):\x20\x20
+         def f ( a):
             pass
 
 

Root/Formatting/Spacing/BlankLine/BlankLineAfterClass/README.rst

@@ -8,8 +8,7 @@
 
 BlankLineAfterClass
 ===================
-Blank lines after classes refer to the blank lines found after classes'
-definitions.
+Those found after classes' definitions.
 
 Tastes
 ========
@@ -34,7 +33,7 @@ This aspect does not have any sub aspects.
 Example
 =======
 
-.. code-block:: python
+.. code-block:: Python 3
 
     class SomeClass:
         def __init__(self):

Root/Formatting/Spacing/BlankLine/BlankLineAfterDeclaration/README.rst

@@ -8,8 +8,7 @@
 
 BlankLineAfterDeclaration
 =========================
-Blank lines after declaration refer to the blank lines found after
-declarations.
+Those found after declarations.
 
 Tastes
 ========
@@ -35,9 +34,15 @@ Example
 
 .. code-block:: C
 
+    #include <stdio.h>
+    
     int main ()
     {
       int a;
+      float b;
+    
+      scanf("%d%f", &a, &b);
+      printf("a = %d and b = %f", a, b);
       return 0;
     }
 

Root/Formatting/Spacing/BlankLine/BlankLineAfterProcedure/README.rst

@@ -8,8 +8,7 @@
 
 BlankLineAfterProcedure
 =======================
-Blank lines after procedures` refer to the blank lines found after
-procedures or functions.
+Those found after procedures or functions.
 
 Tastes
 ========
@@ -19,7 +18,7 @@ Tastes
 +=================================+=====================================================+=====================================================+
 |                                 |                                                     |                                                     |
 |``blank_lines_after_procedures`` | Represents the number of blank lines to use after a | **1**, 0, 2                                         |
-|                                 | procedure or a function                             |                                                     |
+|                                 | procedure ora function                              |                                                     |
 |                                 |                                                     |                                                     |
 +---------------------------------+-----------------------------------------------------+-----------------------------------------------------+
 
@@ -34,13 +33,13 @@ This aspect does not have any sub aspects.
 Example
 =======
 
-.. code-block:: C++
+.. code-block:: C
 
+    #include <stdio.h>
+    
     void proc(void){
         printf("this does nothing");
-    }
-    
-    int add(float a, float b){
+    } int add(float a, float b){
         return a + b;
     }
 

Root/Formatting/Spacing/BlankLine/NewlineAtEOF/README.rst

@@ -8,8 +8,7 @@
 
 NewlineAtEOF
 ============
-A newline character (usually '\n', aka CR or CRLF) at found at the end of
-file.
+Newline character (usually '\\n', aka CR) found at the end of file.
 
 Tastes
 ========
@@ -33,18 +32,18 @@ This aspect does not have any sub aspects.
 Example
 =======
 
-.. code-block:: python
+.. code-block:: Python
 
     def do_nothing():
-        pass\n
+        pass
 
 
 Importance
 ==========
 
-A text file, under unix, consists of a series of lines, each of which
-ends with a newline character (\n). A file that is not empty and does
-not end with a newline is therefore not a text file.
+A text file consists of a series of lines, each of which ends with a
+newline character (\\n). A file that is not empty and does not end
+with a newline is therefore not a text file.
 
 It's not just bad style, it can lead to unexpected behavior, utilities
 that are supposed to operate on text files may not cope well with files