[pre-commit] Fix style issues in files under the docs folder (sonic-net#6647)

What is the motivation for this PR?
pre-commit is a static analysis tool introduced recently. This tool is not able to do diff-only check. It checks the whole files touched by PR. We can't blame PR author for legacy issues. That's why currently the pre-commit check is only optional.

To ensure that we can make pre-commit a mandatory check for PRs submitted to this repository, we need to fix all the legacy issues complained by pre-commit.

How did you do it?
This change fixed all pre-commit issues in files under the `docs` folder.

Signed-off-by: Xin Wang <xiwang5@microsoft.com>

Author: wangxin

docs/ECN-test-plan.md

@@ -44,9 +44,9 @@ The test cases depicted in this document aim to do functional testing of ECN beh
 ### Testbed
 
 ```
-+-------------+      +--------------+      +-------------+       
-| Keysight TX |------|   SONiC DUT  |------| Keysight RX | 
-+-------------+      +--------------+      +-------------+ 
++-------------+      +--------------+      +-------------+
+| Keysight TX |------|   SONiC DUT  |------| Keysight RX |
++-------------+      +--------------+      +-------------+
 
 Keysight ports are connected via SONiC switch as shown in the illustration above.
 ```
@@ -126,7 +126,7 @@ This test aims to verify the DUT’s ECN marking accuracy, e.g., if the actual E
   2. PFC PAUSE storm: Persistent PFC pause frames from the Keysight
         Rx port to the Keysight Tx port. The priorities of PFC pause
         frames should be the same as that of 'Test data traffic'. And the
-        inter-frame transmission interval should be lesser than the 
+        inter-frame transmission interval should be lesser than the
         per-frame pause duration.
 
 #### Test Steps
@@ -144,4 +144,4 @@ This test aims to verify the DUT’s ECN marking accuracy, e.g., if the actual E
    * For the next (Kmax-Kmin) packets, Kmin <= q < Kmax, so their theoretical ECN marking probability should be no larger than Pmax%. As q varies from Kmax to Kmin, the ECN marking probability varies linearly from Pmax to 0.
    * For the last Kmin packets, q<Kmin. So, none of them should be ECN marked.
 7. Repeat steps 1 to 5 at least 200 times.
-8. After 200 iterations, compare between theoretical probability of ECN marking with the actual ECN marking yielded as test results against queue length.
+8. After 200 iterations, compare between theoretical probability of ECN marking with the actual ECN marking yielded as test results against queue length.

docs/api_wiki/README.md

@@ -19,7 +19,7 @@ def test_fun(duthosts, rand_one_dut_hostname, ptfhost):
 
     # example dut api call
     duthost.get_extended_minigraph_facts()
-    
+
     # example ptf api call
     ptfhost.shell("ls")
 ```
@@ -318,7 +318,7 @@ def test_fun(duthosts, rand_one_dut_hostname, ptfhost):
 
 - [get_vtysh_cmd_for_namespace](multi_asic_methods/get_vtysh_cmd_for_namespace.md) - Provides modified VTYSH command provided ASIC namespace and command.
 
-- [has_config_subcommand](multi_asic_methods/has_config_subcommand.md) - Check if a config or show subcommand exists on the remote host. *WARNING*: to test whether it exists, the method will run the command. Ensure that there will be no negative sid-effects of having this command run on 
+- [has_config_subcommand](multi_asic_methods/has_config_subcommand.md) - Check if a config or show subcommand exists on the remote host. *WARNING*: to test whether it exists, the method will run the command. Ensure that there will be no negative sid-effects of having this command run on
 the remote host.
 
 - [is_bgp_state_idle](multi_asic_methods/is_bgp_state_idle.md) - Checks if all BGP peers are in IDLE state on the sonichost.

docs/api_wiki/ansible_methods/announce_routes.md

@@ -25,4 +25,4 @@ def test_fun(localhost):
     - Type: `String`
 
 ## Expected Output
-Provides no meaningful output
+Provides no meaningful output

docs/api_wiki/ansible_methods/bgp_facts.md

@@ -70,4 +70,4 @@ Returns dictionary with information on BGP configuration. The dictionary hierarc
                 - `mrai` - Minimal route advertisement interval
                 - `ip_version`: type of ip version for neighbor
                 - `local AS`: local AS number
-                - `remote routerid`
+                - `remote routerid`

docs/api_wiki/ansible_methods/bgp_route.md

@@ -20,7 +20,7 @@ def test_fun(duthosts, rand_one_dut_hostname, tbinfo):
 
 - `direction` - to restict retrieving bgp neighbor advertise or received routes
     - Required: `False`, unless `neighbor` argument is provided.
-    - Choices: 
+    - Choices:
         - `adv` - Advertising
         - `rec` - Receiving
     - Type: `String`
@@ -46,4 +46,3 @@ Returns a dictionary containing information on the bgp route given the provided
             - `weigh` - tie breaker used to determine best path
             - `nexthop` - nexthop configured for neighbor
             - `aspath` - aspath configured for neighbor
-        

docs/api_wiki/ansible_methods/command.md

@@ -27,7 +27,7 @@ def test_fun(duthosts, rand_one_dut_hostname):
     - Required: `True` if `cmd` or free-form argument is not provided, `False` otherwise.
     - Type: `List`
         - Element-Type: `String`
-- `chdir` - change into specified directory before running 
+- `chdir` - change into specified directory before running
     - Required: `False`
     - Type: `String`
 - `cmd` - The command to be run as a string with space dilineated options.
@@ -67,4 +67,4 @@ Dictionary with information on command output:
 - `stderr` - The standard error as a string
 - `stderr_lines`- The standard error as a list of strings
 - `stdout` - the standard output as a string
-- `stdout_lines` - the standard output as a list of strings
+- `stdout_lines` - the standard output as a list of strings

docs/api_wiki/ansible_methods/config_facts.md

@@ -35,4 +35,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
 
 ## Expected Output
 
-Output is too long to reasonably document on this page. Though documentation should be added on commonly used features.
+Output is too long to reasonably document on this page. Though documentation should be added on commonly used features.

docs/api_wiki/ansible_methods/conn_graph_facts.md

@@ -46,4 +46,3 @@ def test_fun(localhost):
 - `device_console_link` - The console server port connected to the device
 - `device_pdu_info` - The device's pdu server type, mgmtip, hwsku and protocol
 - `device_pdu_links` - The pdu server ports connected to the device
-

docs/api_wiki/ansible_methods/console_facts.md

@@ -20,4 +20,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
 This method takes no arguments
 
 ## Expected Output
-Was not able to get sufficient output with my testbed. If you are contributor with console enabled, consider contributing your output.
+Was not able to get sufficient output with my testbed. If you are contributor with console enabled, consider contributing your output.

docs/api_wiki/ansible_methods/copy.md

@@ -45,7 +45,7 @@ def test_fun(duthosts, rand_one_dut_hostname):
 - `owner` - Name of use that should own file/directory
     - Required: `False`
     - Type: `String`
-- `remote_src` - Whether `src` is on the remote host or on the calling device. 
+- `remote_src` - Whether `src` is on the remote host or on the calling device.
     - Required: `False`
     - Type: `Boolean`
     - Default: `False`
@@ -84,4 +84,4 @@ Returns dictionary that provides info on the copied file.
 - `size` - size of copied file
 - `src` - source file was copied from
 - `state` - staet of the copied file (`file`, `directory`)
-- `uid` - Owner id for the file
+- `uid` - Owner id for the file

docs/api_wiki/ansible_methods/exabgp.md

@@ -11,8 +11,8 @@ Start or stop exabgp instance with certain configurations
 ## Examples
 ```
 def test_fun(ptfhost):
-    ptfhost.exabgp(name="t1", 
-                   state="started", 
+    ptfhost.exabgp(name="t1",
+                   state="started",
                    router_id="10.0.0.0",
                    local_ip="10.0.0.0",
                    peer_ip="10.0.0.1",
@@ -65,4 +65,4 @@ def test_fun(ptfhost):
     - Default: `False`
 
 ## Expected Output
-No useful output is returned.
+No useful output is returned.

docs/api_wiki/ansible_methods/extract_log.md

@@ -35,4 +35,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
     - Default: `None`
 
 ## Expected Output
-Provides no output
+Provides no output

docs/api_wiki/ansible_methods/feature_facts.md

@@ -24,4 +24,4 @@ Returns a dictionary with information on the features. The dictionary hierarchy
 
 - `ansible_facts`
     - `feature_facts`
-        - `{FEATURE_NAME}` - `enabled`\\`disabled`
+        - `{FEATURE_NAME}` - `enabled`\\`disabled`

docs/api_wiki/ansible_methods/fetch.md

@@ -6,7 +6,7 @@
 - [Expected Output](#expected-output)
 
 ## Overview
-Copies file from remote host to local host. 
+Copies file from remote host to local host.
 
 This method may not perform as expected. Given a remote src, a local dest, and the hostname of the remote device, the final location will look like this on the local machine:
 
@@ -43,4 +43,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
     - Default: `True`
 
 ## Expected Output
-This method provides no useful output.
+This method provides no useful output.

docs/api_wiki/ansible_methods/file.md

@@ -93,4 +93,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
 Dictionary with basic information.
 
 - `dest` - destination of path
-- `path` - destination of path
+- `path` - destination of path

docs/api_wiki/ansible_methods/find.md

@@ -102,4 +102,4 @@ Returns dictionary that provides information on the process as well as stats on
 
 - `examined` - Number of files examined
 - `matched` - Number of files matched
-- `files` - List of dictionaries corresponding to each matched file. For description of dictionary, see output of [duthost.stat](stat.md)
+- `files` - List of dictionaries corresponding to each matched file. For description of dictionary, see output of [duthost.stat](stat.md)

docs/api_wiki/ansible_methods/get_ip_in_range.md

@@ -40,4 +40,4 @@ Returns dictionary containing generated ips. The dictionary hierarchy is describ
 - `ansible_facts`
      - `generated_ips` - list of generated ips
 
-(u'ansible_facts', {u'generated_ips': [u'192.168.0.1/21', u'192.168.0.2/21']})
+(u'ansible_facts', {u'generated_ips': [u'192.168.0.1/21', u'192.168.0.2/21']})

docs/api_wiki/ansible_methods/image_facts.md

@@ -27,4 +27,3 @@ A dictionary is returned with information on the remote host's laoded image. The
         - `available` - List of available images
         - `current` - Currently loaded image
         - `next` - latest available image
-        

docs/api_wiki/ansible_methods/interface_facts.md

@@ -42,4 +42,4 @@ Returns a dictionary with information on interfaces. The dictionary hierarchy is
                 - `scope`
                 - `prefix` - address prefix
             - `active` - Whether or not interface is active
-            - `type` - type of interface
+            - `type` - type of interface

docs/api_wiki/ansible_methods/lldp_facts.md

@@ -61,4 +61,4 @@ def test_fun(localhost, duthosts, rand_one_dut_hostname):
 ## Expected Output
 
 # TODO
-Unable to test output. Timeout on my system due to it being slow.
+Unable to test output. Timeout on my system due to it being slow.

docs/api_wiki/ansible_methods/minigraph_facts.md

@@ -107,7 +107,7 @@ A dictionary would be returned containing info on the minigraph. The dictionary
             - `mgmt_addr` - mgmt address for specified device
             - `hwsku` - Type of hardware switch being used
             - `type` - type of device
-    
+
     - `minigraph_bgp_asn` - BGP asn configured by minigraph
     - `minigraph_neighbors` - provides information on neighbor ports
         - `{PORT_NAME}` - Dictionary providing information on port
@@ -120,4 +120,4 @@ A dictionary would be returned containing info on the minigraph. The dictionary
         - `mask` - subnet mask
         - `addr` - address configured for interface
         - `attachto` - name of VLAN interface is attached to
-    - `minigraph_hwsku` - type of hardware switch being used by `minigraph_hostname`
+    - `minigraph_hwsku` - type of hardware switch being used by `minigraph_hostname`

docs/api_wiki/ansible_methods/monit_process.md

@@ -28,7 +28,7 @@ def test_fun(duthosts, rand_one_dut_hostname):
     - Default: `12`
 
 ## Expected Output
-Dictionary describing the cpu and memory usage of all processes. The dictionary hierarchy is described below, with each indentation describing a sub-dictionary: 
+Dictionary describing the cpu and memory usage of all processes. The dictionary hierarchy is described below, with each indentation describing a sub-dictionary:
 
 - `monit_results` - List of dictionaries, where each dictionary refers to a separate process
     - `status` - Whether process is runing or not

docs/api_wiki/ansible_methods/ping.md

@@ -25,4 +25,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
 ## Expected Output
 Dictionary with value returned from host.
 
-- `ping` - Value returned from host
+- `ping` - Value returned from host

docs/api_wiki/ansible_methods/port_alias.md

@@ -44,4 +44,4 @@ Returns dictionary with port aliases and port speeds. The dictionary hierarchy i
 - `ansible_facts` - Dictionary containing port info
     - `port_alias` - list of port aliases
     - `port_speed` - Dictionary that maps aliases to thier speed
-        - `{PORT_ALIAS}` - speed of specified port
+        - `{PORT_ALIAS}` - speed of specified port

docs/api_wiki/ansible_methods/reduce_and_add_sonic_images.md

@@ -25,4 +25,4 @@ duthost.reduce_and_add_sonic_images(new_image_url={URL_TO_SONIC_IMAGE})
 Simple dictionary showing which image was downloaded. The dictionary hierarchy is described below, with each indentation describing a sub-dictionary:
 
 - `ansible_facts`
-    - `downlaoded_iamge_version` - version of image downloaded
+    - `downlaoded_iamge_version` - version of image downloaded

docs/api_wiki/ansible_methods/replace.md

@@ -8,7 +8,7 @@
 ## Overview
 Replaces all instances of a pattern within a specified file. When using this method make sure that the pattern being used to match does not match the replacement text, otherwise the results may be undesirable.
 
-[docs](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/replace_module.html) used to help generate this page. 
+[docs](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/replace_module.html) used to help generate this page.
 
 ## Examples
 ```
@@ -78,4 +78,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
     - Type: `Boolean`
 
 ## Expected Output
-Method provides no useful output.
+Method provides no useful output.

docs/api_wiki/ansible_methods/service.md

@@ -50,4 +50,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
     - Default: `auto`
 
 ## Expected Output
-Provides no useful output. Will error if bad args are provided.
+Provides no useful output. Will error if bad args are provided.

docs/api_wiki/ansible_methods/setup.md

@@ -23,4 +23,4 @@ This method takes no arguments
 
 ## Expected Output
 
-The output for this command is far too long to reasonably document. Commonly used properties should be documented at some point.
+The output for this command is far too long to reasonably document. Commonly used properties should be documented at some point.

docs/api_wiki/ansible_methods/shell.md

@@ -6,7 +6,7 @@
 - [Expected Output](#expected-output)
 
 ## Overview
-Runs commands on the remote host. 
+Runs commands on the remote host.
 
 Similar to [command](command.md) except that it runs commands through a shell `/bin/sh`.
 
@@ -56,4 +56,4 @@ Dictionary with information on command output:
 - `stderr` - The standard error as a string
 - `stderr_lines`- The standard error as a list of strings
 - `stdout` - the standard output as a string
-- `stdout_lines` - the standard output as a list of strings
+- `stdout_lines` - the standard output as a list of strings

docs/api_wiki/ansible_methods/shell_cmds.md

@@ -39,4 +39,4 @@ A dictionary with results from commands run. The dictionary hierarchy is describ
     - `stdout_lines` - What was printed to stdout (split by line) during execution of command
     - `stdout` - What was printed to stdout (as one string) during execution of command
     - `cmd` - command that was run
-    - `rc` - return code
+    - `rc` - return code

docs/api_wiki/ansible_methods/show_interface.md

@@ -39,7 +39,7 @@ def test_fun(duthosts, rand_one_dut_hostname):
     - Default: `False`
 
 ## Expected Output
-Will return a dictionary describing either status or counters depending on argument provided. 
+Will return a dictionary describing either status or counters depending on argument provided.
 
 ### status
 
@@ -69,4 +69,4 @@ The dictionary hierarchy is described below, with each indentation describing a
             - `TX_OK` - Packets correctly transmitted
             - `TX_ERR` - Packets incorrectly transmitted
             - `TX_DRP` - Dropped Packets transmitted
-            - `TX_OVR` - Packets unable to be transmitted
+            - `TX_OVR` - Packets unable to be transmitted

docs/api_wiki/ansible_methods/show_ip_interface.md

@@ -31,5 +31,5 @@ Provides a dictionary with information on the interfaces. The dictionary hierarc
             - `ipv4` - interface configured ipv4 address
             - `peer_ipv4` - BGP neighbor ipv4 address
             - `admin` - admin state
-            - `oper_state` - operator state 
-            - `prefix_len` - interface prefix length
+            - `oper_state` - operator state
+            - `prefix_len` - interface prefix length

docs/api_wiki/ansible_methods/sonic_pfc_counters.md

@@ -30,4 +30,4 @@ Returns dictionary with information on interfaces and their counters. The dictio
 - `ansible_facts`
     - `{INTERFACE_NAME}` - Dictionary with counters for specified interface
         - `Rx` - list of counters for recieved packets
-        - `Tx` - list of counters for transmitted packets
+        - `Tx` - list of counters for transmitted packets

docs/api_wiki/ansible_methods/stat.md

@@ -114,4 +114,4 @@ Returns dictionary of stats regarding the provided file (whether or not the file
     - `wusr` - Whether owner can write to file
     - `xgrp` - Whether owner group can execute file
     - `xoth` - Whether others can execute file
-    - `xusr` - Whether owner can execute file
+    - `xusr` - Whether owner can execute file

docs/api_wiki/ansible_methods/switch_arptable.md

@@ -33,4 +33,4 @@ Returns a dictionary that describes the contents of the ARP table. The dictionar
             - `{IPV6_ADDRESS}` - dictionary containing information on entry associated with provided address
                 - `interface` - name of interface associated with address
                 - `macaddress` - macaddress for entry
-                - `state` - state of interface
+                - `state` - state of interface

docs/api_wiki/ansible_methods/sysfs_facts.md

@@ -25,4 +25,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
 ## Expected Output
 
 ## TODO
-Was not able to run on local machine.
+Was not able to run on local machine.

docs/api_wiki/ansible_methods/tempfile.md

@@ -39,4 +39,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
 ## Expected Output
 Dictionary that just has the path to the temp file on the remote host.
 
-- `path` - path to created temp file or directory
+- `path` - path to created temp file or directory

docs/api_wiki/multi_asic_methods/asic_instance.md

@@ -22,4 +22,4 @@ def test_fun(duthosts, rand_one_dut_hostname, enum_frontend_asic_index):
     - Type: `Integer`
 
 ## Expected Output
-The ASIC instance corresponding to the provided ID.S
+The ASIC instance corresponding to the provided ID.S

docs/api_wiki/multi_asic_methods/asic_instance_from_namespace.md

@@ -27,4 +27,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
     - Default: `$DEFAULT_NAMESPACE`
 
 ## Expected Output
-An ASIC instance corresponding to provided `namespace`
+An ASIC instance corresponding to provided `namespace`

docs/api_wiki/multi_asic_methods/asics.md

@@ -22,4 +22,4 @@ def test_fun(duthosts, rand_one_dut_hostname):
 This method takes no arguments
 
 ## Expected Output
-List of ASIC hosts.
+List of ASIC hosts.