ios & iosxr Documentation improvements (#4321)

network/ios/ios_command.py

@@ -24,7 +24,7 @@ author: "Peter Sprygada (@privateip)"
 short_description: Run commands on remote devices running Cisco IOS
 description:
   - Sends arbitrary commands to an ios node and returns the results
-    read from the device. The M(ios_command) module includes an
+    read from the device. This module includes an
     argument that will cause the module to wait for a specific condition
     before returning or timing out if the condition is not met.
   - This module does not support running commands in configuration mode.
@@ -35,7 +35,7 @@ options:
     description:
       - List of commands to send to the remote ios device over the
         configured provider. The resulting output from the command
-        is returned. If the I(waitfor) argument is provided, the
+        is returned. If the I(wait_for) argument is provided, the
         module is not returned until the condition is satisfied or
         the number of retries has expired.
     required: true
@@ -55,7 +55,7 @@ options:
       - Specifies the number of retries a command should by tried
         before it is considered failed. The command is run on the
         target device every retry and evaluated against the
-        I(waitfor) conditions.
+        I(wait_for) conditions.
     required: false
     default: 10
   interval:

network/ios/ios_config.py

@@ -52,8 +52,8 @@ options:
       - Specifies the source path to the file that contains the configuration
         or configuration template to load.  The path to the source file can
         either be the full path on the Ansible control host or a relative
-        path from the playbook or role root dir.  This argument is mutually
-        exclusive with O(lines).
+        path from the playbook or role root directory.  This argument is mutually
+        exclusive with I(lines).
     required: false
     default: null
     version_added: "2.2"
@@ -62,11 +62,11 @@ options:
       - Configures a destination file to write the source template or config
         updates to.  The path to the destination file can either be a full
         path on the Ansible control host or a relative path from the
-        playbook or role root dir.  This will, by default, overwrite any
-        previously created file.  See O(append) to change the behavior.
-      - When the O(dest) argument is used, the output from processing the
+        playbook or role root directory.  This will, by default, overwrite any
+        previously created file.  See I(append) to change the behavior.
+      - When the I(dest) argument is used, the output from processing the
         configuration lines is written to a file and not to the actual
-        device.  If the O(dest) argument is omitted, then the configuration
+        device.  If theI(dest) argument is omitted, then the configuration
         is written to the device.
     required: false
     default: null
@@ -74,7 +74,7 @@ options:
   append:
     description:
       - Changes the default behavior when writing the configuration out
-        to a remote file on disk.  By default if O(dest) is specified, the
+        to a remote file on disk.  By default if I(dest) is specified, the
         file is overridden.  By setting this argument to true, the remote
         file (if it exists) is appended to.
     required: false

network/ios/ios_facts.py

@@ -23,8 +23,8 @@ author: "Peter Sprygada (@privateip)"
 short_description: Collect facts from remote devices running IOS
 description:
   - Collects a base set of device facts from a remote device that
-    is running IOS.  The M(ios_facts) module prepends all of the
-    base network fact keys with U(ansible_net_<fact>).  The facts
+    is running IOS.  This module prepends all of the
+    base network fact keys with C(ansible_net_<fact>).  The facts
     module will always collect a base set of facts from the device
     and can enable or disable collection of additional facts.
 extends_documentation_fragment: ios
@@ -184,8 +184,8 @@ class Hardware(FactsBase):
         data = self.runner.get_command('show memory statistics | include Processor')
         match = re.findall('\s(\d+)\s', data)
         if match:
-            self.facts['memtotal_mb'] = int(match[0])/1024
-            self.facts['memfree_mb'] = int(match[1])/1024
+            self.facts['memtotal_mb'] = int(match[0]) / 1024
+            self.facts['memfree_mb'] = int(match[1]) / 1024
 
     def parse_filesystems(self, data):
         return re.findall(r'^Directory of (\S+)/', data, re.M)

network/ios/ios_template.py

@@ -55,8 +55,7 @@ options:
         issued to add any necessary flags to collect all defaults as
         well as the device configuration.  If the destination device
         does not support such a flag, this argument is silently ignored.
-    required: false
-    default: false
+    required: true
     choices: [ "true", "false" ]
   backup:
     description:

network/iosxr/iosxr_command.py

@@ -24,7 +24,7 @@ author: "Peter Sprygada (@privateip)"
 short_description: Run arbitrary commands on ios devices.
 description:
   - Sends arbitrary commands to an IOSXR node and returns the results
-    read from the device. The M(iosxr_command) module includes an
+    read from the device. This module includes an
     argument that will cause the module to wait for a specific condition
     before returning or timing out if the condition is not met.
 extends_documentation_fragment: iosxr

network/iosxr/iosxr_config.py

@@ -23,8 +23,8 @@ version_added: "2.1"
 author: "Peter Sprygada (@privateip)"
 short_description: Manage Cisco IOS XR configuration sections
 description:
-  - Cisco IOS XR configurations use a simple block indent file sytanx
-    for segementing configuration into sections.  This module provides
+  - Cisco IOS XR configurations use a simple block indent file syntax
+    for segmenting configuration into sections.  This module provides
     an implementation for working with IOS XR configuration sections in
     a deterministic way.  This module works with either CLI or NXAPI
     transports.
@@ -101,8 +101,8 @@ options:
         against the contents of source.  There are times when it is not
         desirable to have the task get the current running-config for
         every task in a playbook.  The I(config) argument allows the
-        implementer to pass in the configuruation to use as the base
-        config for comparision.
+        implementer to pass in the configuration to use as the base
+        config for comparison.
     required: false
     default: null
 """

network/iosxr/iosxr_template.py

@@ -23,9 +23,9 @@ author: "Peter sprygada (@privateip)"
 short_description: Manage Cisco IOSXR device configurations over SSH
 description:
   - Manages network device configurations over SSH.  This module
-    allows implementors to work with the device running-config.  It
+    allows implementers to work with the device running-config.  It
     provides a way to push a set of commands onto a network device
-    by evaluting the current running-config and only pushing configuration
+    by evaluating the current running-config and only pushing configuration
     commands that are not already configured.  The config source can
     be a set of commands or a template.
 extends_documentation_fragment: ios
@@ -64,8 +64,8 @@ options:
         against the contents of source.  There are times when it is not
         desirable to have the task get the current running-config for
         every task.  The I(config) argument allows the implementer to
-        pass in the configuruation to use as the base config for
-        comparision.
+        pass in the configuration to use as the base config for
+        comparison.
     required: false
     default: null
 """
@@ -81,7 +81,7 @@ EXAMPLES = """
     src: config.j2
     force: yes
 
-- name: provide the base configuration for comparision
+- name: provide the base configuration for comparison
   net_config:
     src: candidate_config.txt
     config: current_config.txt