[vyos] Update docs for vyos.ospfv2 (#50)

[vyos] Update docs for vyos.ospfv2 Reviewed-by: https://github.com/apps/ansible-zuul
vyos · Jun 23, 2020 · 5de0800 · 5de0800
1 parent e1fb324
commit 5de0800
Show file tree

Hide file tree

Showing 29 changed files with 3 additions and 55 deletions.
diff --git a/README.md b/README.md
@@ -157,4 +157,4 @@ Please read and familiarize yourself with this document.
 
 GNU General Public License v3.0 or later.
 
-See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.
+See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.
diff --git a/docs/vyos.vyos.vyos_banner_module.rst b/docs/vyos.vyos.vyos_banner_module.rst
@@ -283,5 +283,3 @@ Authors
 - Trishna Guha (@trishnaguha)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_command_module.rst b/docs/vyos.vyos.vyos_command_module.rst
@@ -377,5 +377,3 @@ Authors
 - Nathaniel Case (@Qalthos)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst
@@ -514,5 +514,3 @@ Authors
 - Nathaniel Case (@Qalthos)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst
@@ -429,5 +429,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_firewall_global_module.rst b/docs/vyos.vyos.vyos_firewall_global_module.rst
@@ -1739,5 +1739,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_firewall_interfaces_module.rst b/docs/vyos.vyos.vyos_firewall_interfaces_module.rst
@@ -1411,5 +1411,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_firewall_rules_module.rst b/docs/vyos.vyos.vyos_firewall_rules_module.rst
@@ -2438,5 +2438,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst
@@ -488,5 +488,3 @@ Authors
 - Ganesh Nalawade (@ganeshrn)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_interfaces_module.rst b/docs/vyos.vyos.vyos_interfaces_module.rst
@@ -1329,5 +1329,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_l3_interface_module.rst b/docs/vyos.vyos.vyos_l3_interface_module.rst
@@ -329,5 +329,3 @@ Authors
 - Ricardo Carrillo Cruz (@rcarrillocruz)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_l3_interfaces_module.rst b/docs/vyos.vyos.vyos_l3_interfaces_module.rst
@@ -768,5 +768,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_lag_interfaces_module.rst b/docs/vyos.vyos.vyos_lag_interfaces_module.rst
@@ -947,5 +947,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_linkagg_module.rst b/docs/vyos.vyos.vyos_linkagg_module.rst
@@ -343,5 +343,3 @@ Authors
 - Ricardo Carrillo Cruz (@rcarrillocruz)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_lldp_global_module.rst b/docs/vyos.vyos.vyos_lldp_global_module.rst
@@ -612,5 +612,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_lldp_interface_module.rst b/docs/vyos.vyos.vyos_lldp_interface_module.rst
@@ -307,5 +307,3 @@ Authors
 - Ricardo Carrillo Cruz (@rcarrillocruz)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_lldp_interfaces_module.rst b/docs/vyos.vyos.vyos_lldp_interfaces_module.rst
@@ -926,5 +926,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_lldp_module.rst b/docs/vyos.vyos.vyos_lldp_module.rst
@@ -271,5 +271,3 @@ Authors
 - Ricardo Carrillo Cruz (@rcarrillocruz)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst
@@ -351,5 +351,3 @@ Authors
 - Trishna Guha (@trishnaguha)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_ospfv2_module.rst b/docs/vyos.vyos.vyos_ospfv2_module.rst
@@ -1208,6 +1208,7 @@ Parameters
                                 <td>
                                                                                                                                                             </td>
                                                                 <td>
+                                            <div>OSPFv2 specific parameters.</div>
                                                         </td>
             </tr>
                                                             <tr>
@@ -3118,5 +3119,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_ospfv3_module.rst b/docs/vyos.vyos.vyos_ospfv3_module.rst
@@ -916,5 +916,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_ping_module.rst b/docs/vyos.vyos.vyos_ping_module.rst
@@ -425,5 +425,3 @@ Authors
 - Nilashish Chakraborty (@NilashishC)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst
@@ -354,5 +354,3 @@ Authors
 - Trishna Guha (@trishnaguha)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_static_routes_module.rst b/docs/vyos.vyos.vyos_static_routes_module.rst
@@ -1162,5 +1162,3 @@ Authors
 - Rohit Thakur (@rohitthakur2590)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_system_module.rst b/docs/vyos.vyos.vyos_system_module.rst
@@ -314,5 +314,3 @@ Authors
 - Nathaniel Case (@Qalthos)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_user_module.rst b/docs/vyos.vyos.vyos_user_module.rst
@@ -373,5 +373,3 @@ Authors
 - Trishna Guha (@trishnaguha)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst
@@ -401,5 +401,3 @@ Authors
 - Trishna Guha (@trishnaguha)
 
 
-.. hint::
-    Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
diff --git a/plugins/modules/vyos_ospfv2.py b/plugins/modules/vyos_ospfv2.py
@@ -261,7 +261,7 @@
             description: Neighbor priority.
             type: int
       parameters:
-        descriptions: OSPFv2 specific parameters.
+        description: OSPFv2 specific parameters.
         type: dict
         suboptions:
           abr_type:

diff --git a/tests/sanity/ignore-2.9.txt b/tests/sanity/ignore-2.9.txt
@@ -62,7 +62,6 @@ plugins/modules/vyos_logging.py validate-modules:doc-missing-type
 plugins/modules/vyos_logging.py validate-modules:missing-suboption-docs
 plugins/modules/vyos_logging.py validate-modules:parameter-type-not-in-doc
 plugins/modules/vyos_logging.py validate-modules:undocumented-parameter
-plugins/modules/vyos_ospfv2.py validate-modules:invalid-documentation
 plugins/modules/vyos_ospfv3.py validate-modules:invalid-documentation
 plugins/modules/vyos_ping.py validate-modules:doc-default-does-not-match-spec
 plugins/modules/vyos_ping.py validate-modules:parameter-type-not-in-doc
Original file line number	Diff line number	Diff line change
Expand Up		@@ -157,4 +157,4 @@ Please read and familiarize yourself with this document.

		GNU General Public License v3.0 or later.

		See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.
		See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -283,5 +283,3 @@ Authors
		- Trishna Guha (@trishnaguha)


		.. hint::
		Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -377,5 +377,3 @@ Authors
		- Nathaniel Case (@Qalthos)


		.. hint::
		Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -514,5 +514,3 @@ Authors
		- Nathaniel Case (@Qalthos)


		.. hint::
		Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -429,5 +429,3 @@ Authors
		- Rohit Thakur (@rohitthakur2590)


		.. hint::
		Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1739,5 +1739,3 @@ Authors
		- Rohit Thakur (@rohitthakur2590)


		.. hint::
		Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1411,5 +1411,3 @@ Authors
		- Rohit Thakur (@rohitthakur2590)


		.. hint::
		Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2438,5 +2438,3 @@ Authors
		- Rohit Thakur (@rohitthakur2590)


		.. hint::
		Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -488,5 +488,3 @@ Authors
		- Ganesh Nalawade (@ganeshrn)


		.. hint::
		Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1329,5 +1329,3 @@ Authors
		- Rohit Thakur (@rohitthakur2590)


		.. hint::
		Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.