Update default values in argspec and module docs (#154)

Update default values in argspec and module docs Reviewed-by: Nilashish Chakraborty <nilashishchakraborty8@gmail.com> /~https://github.com/NilashishC
ansible-collections · Jan 22, 2021 · cfc6afc · cfc6afc
1 parent 4890dad
commit cfc6afc
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 13 deletions.
diff --git a/changelogs/fragments/update_docs_default_values.yaml b/changelogs/fragments/update_docs_default_values.yaml
@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - Update default values in module argspec and docs (/~https://github.com/ansible-collections/arista.eos/pull/154).
diff --git a/docs/arista.eos.eos_acls_module.rst b/docs/arista.eos.eos_acls_module.rst
@@ -2752,7 +2752,7 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
+                                    <li>no</li>
                                     <li>yes</li>
                         </ul>
                 </td>

diff --git a/docs/arista.eos.eos_eapi_module.rst b/docs/arista.eos.eos_eapi_module.rst
@@ -67,7 +67,7 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
+                                    <li>no</li>
                                     <li>yes</li>
                         </ul>
                 </td>
@@ -137,7 +137,7 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
+                                    <li>no</li>
                                     <li>yes</li>
                         </ul>
                 </td>
@@ -409,7 +409,7 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
+                                    <li>no</li>
                                     <li>yes</li>
                         </ul>
                 </td>

diff --git a/docs/arista.eos.eos_l3_interfaces_module.rst b/docs/arista.eos.eos_l3_interfaces_module.rst
@@ -96,7 +96,7 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
+                                    <li>no</li>
                                     <li>yes</li>
                         </ul>
                 </td>

diff --git a/docs/arista.eos.eos_ospf_interfaces_module.rst b/docs/arista.eos.eos_ospf_interfaces_module.rst
@@ -1061,7 +1061,6 @@ Parameters
                     <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                     <div style="font-size: small">
                         <span style="color: purple">string</span>
-                         / <span style="color: red">required</span>
                     </div>
                 </td>
                 <td>

diff --git a/plugins/module_utils/network/eos/eos.py b/plugins/module_utils/network/eos/eos.py
@@ -60,7 +60,9 @@
         fallback=(env_fallback, ["ANSIBLE_NET_SSH_KEYFILE"]), type="path"
     ),
     "authorize": dict(
-        fallback=(env_fallback, ["ANSIBLE_NET_AUTHORIZE"]), type="bool"
+        fallback=(env_fallback, ["ANSIBLE_NET_AUTHORIZE"]),
+        type="bool",
+        default=False,
     ),
     "auth_pass": dict(
         no_log=True, fallback=(env_fallback, ["ANSIBLE_NET_AUTH_PASS"])

diff --git a/plugins/modules/eos_acls.py b/plugins/modules/eos_acls.py
@@ -62,7 +62,6 @@
           standard:
             description: standard access-list or not
             type: bool
-            default: false
           name:
             description: Name of the acl-list
             type: str

diff --git a/plugins/modules/eos_eapi.py b/plugins/modules/eos_eapi.py
@@ -45,7 +45,6 @@
       is disabled. By default, when eAPI is first configured, the HTTP protocol is
       disabled.
     type: bool
-    default: no
     aliases:
     - enable_http
   http_port:
@@ -78,7 +77,6 @@
       only.  When the value is set to False, the HTTP local protocol is disabled.
     - Note is value is independent of the C(http) argument
     type: bool
-    default: no
     aliases:
     - enable_local_http
   local_http_port:
@@ -95,7 +93,6 @@
       UDS will not be available to handle requests.  By default when eAPI is first
       configured, the UDS is disabled.
     type: bool
-    default: no
     aliases:
     - enable_socket
   timeout:

diff --git a/plugins/modules/eos_l3_interfaces.py b/plugins/modules/eos_l3_interfaces.py
@@ -70,7 +70,6 @@
             description:
             - Whether or not this address is a secondary address.
             type: bool
-            default: false
       ipv6:
         description:
         - List of IPv6 addresses to be set for the Layer 3 interface mentioned in

diff --git a/plugins/modules/eos_ospf_interfaces.py b/plugins/modules/eos_ospf_interfaces.py
@@ -47,7 +47,6 @@
         description:
         - Name/Identifier of the interface.
         type: str
-        required: True
       address_family:
         description:
         - OSPF settings on the interfaces in address-family context.