Issue#1510: Added docs for new rules to handle multiline variable initialisations.

Author: JHertz5

docs/configuring_array_multiline_structure_rules.rst

@@ -566,4 +566,5 @@ Rules Enforcing Array Multiline Structure Rules
 * `concurrent_012 <concurrent_rules.html#concurrent-012>`_
 * `constant_016 <constant_rules.html#constant-016>`_
 * `sequential_009 <sequential_rules.html#sequential-009>`_
+* `variable_403 <variable_rules.html#variable-403>`_
 * `variable_assignment_008 <variable_assignment_rules.html#variable-assignment-008>`_

docs/configuring_multiline_indent_rules.rst

@@ -128,5 +128,6 @@ Rules Enforcing Multiline Indent Rules
 * `sequential_402 <sequential_rules.html#sequential-402>`_
 * `signal_400 <signal_rules.html#signal-400>`_
 * `variable_400 <signal_rules.html#variable-400>`_
+* `variable_402 <signal_rules.html#variable-402>`_
 * `variable_assignment_004 <variable_assignment_rules.html#variable-assignment-004>`_
 * `variable_assignment_401 <variable_assignment_rules.html#variable-assignment-401>`_

docs/rule_groups/alignment_rule_group.rst

@@ -80,6 +80,7 @@ Rules Enforcing Alignment Rule Group
 * `type_400 <../type_rules.html#type-400>`_
 * `variable_400 <../variable_rules.html#variable-400>`_
 * `variable_401 <../variable_rules.html#variable-401>`_
+* `variable_402 <../variable_rules.html#variable-402>`_
 * `variable_assignment_004 <../variable_assignment_rules.html#variable-assignment-004>`_
 * `variable_assignment_400 <../variable_assignment_rules.html#variable-assignment-400>`_
 * `variable_assignment_401 <../variable_assignment_rules.html#variable-assignment-401>`_

docs/rule_groups/structure_rule_group.rst

@@ -189,6 +189,7 @@ Rules Enforcing Structure Rule Group
 * `variable_015 <../variable_rules.html#variable-015>`_
 * `variable_017 <../variable_rules.html#variable-017>`_
 * `variable_018 <../variable_rules.html#variable-018>`_
+* `variable_403 <../variable_rules.html#variable-403>`_
 * `variable_assignment_006 <../variable_assignment_rules.html#variable-assignment-006>`_
 * `variable_assignment_007 <../variable_assignment_rules.html#variable-assignment-007>`_
 * `variable_assignment_008 <../variable_assignment_rules.html#variable-assignment-008>`_

docs/variable_rules.rst

@@ -472,6 +472,67 @@ This rule checks the alignment of assignment keywords in variable declarations.
      others            => false
    );
 
+variable_402
+############
+
+|phase_5| |error| |alignment|
+
+This rule checks the alignment of multiline variable initializations that contain arrays.
+
+|configuring_multiline_indent_rules_link|
+
+.. NOTE:: The structure of multiline array variables is handled by the rule `variable_403 <variable_rules.html#variable-403>`_.
+
+**Violation**
+
+.. code-block:: vhdl
+
+   variable rom : romq_type :=
+   (
+            0,
+        65535,
+        32768
+     );
+
+**Fix**
+
+.. code-block:: vhdl
+
+   variable rom : romq_type :=
+   (
+     0,
+     65535,
+     32768
+   );
+
+variable_403
+############
+
+|phase_5| |error| |structure|
+
+This rule checks the structure of multiline variable initializations that contain arrays.
+
+|configuring_array_multiline_structure_rules_link|
+
+.. NOTE:: The indenting of multiline array variables is handled by the rule `variable_402 <variable_rules.html#variable-402>`_.
+
+**Violation**
+
+.. code-block:: vhdl
+
+   variable rom : romq_type := (0, 65535, 32768);
+
+**Fix**
+
+.. code-block:: vhdl
+
+   variable rom : romq_type :=
+   (
+     0,
+     65535,
+     32768
+   );
+
 variable_500
 ############
 

vsg/rules/variable/rule_402.py

@@ -10,7 +10,7 @@
 
 class rule_402(Rule):
     """
-    This rule checks the alignment of multiline variables that contain arrays.
+    This rule checks the alignment of multiline variable initializations that contain arrays.
 
     |configuring_multiline_indent_rules_link|
 

vsg/rules/variable/rule_403.py

@@ -9,7 +9,7 @@
 
 class rule_403(Rule):
     """
-    This rule checks the structure of multiline variables that contain arrays.
+    This rule checks the structure of multiline variable initializations that contain arrays.
 
     |configuring_array_multiline_structure_rules_link|