updated documentation for verbose-module-output

.github/ISSUE_TEMPLATE/problem.yml

@@ -106,7 +106,7 @@ body:
     attributes:
       label: Debug Output
       description: |
-        Set the [debug option](https://opnsense.ansibleguy.net/en/latest/usage/4_develop.html#debugging) and copy its output.
+        Set the [debug option](https://opnsense.ansibleguy.net/en/latest/usage/3_troubleshoot.html#verbose-output) and copy its output.
       render: bash
     validations:
       required: true
@@ -117,7 +117,7 @@ body:
       label: Profiling Output
       description: |
         If the issue is related to time-consumption, you may also add the content of the
-        [profiling logs](https://opnsense.ansibleguy.net/en/latest/usage/4_develop.html#profiling).
+        [profiling logs](https://opnsense.ansibleguy.net/en/latest/usage/3_troubleshoot.html#verbose-output).
       render: bash
     validations:
       required: false

docs/source/usage/3_troubleshoot.rst

@@ -20,6 +20,30 @@ Per example:
     # ERROR:
     {'rule.interface': 'option not in list'}
 
+Verbose output
+**************
+
+You can also use the :code:`debug` argument to enable verbose output:
+
+.. code-block:: yaml
+
+    - name: Example
+      ansibleguy.opnsense.alias:
+        debug: true
+
+When the debug-mode is enabled some useful log files are created in the directory :code:`/tmp/ansibleguy.opnsense` (*HTTP requests made, profiling of time consumption*)
+
+If you only want the profiling logs written, you can also use the :code:`profiling` argument:
+
+.. code-block:: yaml
+
+    - name: Example
+      ansibleguy.opnsense.alias:
+        profiling: true
+
+
+'Multi' modules also support these parameters on a per-item basis - so you don't get flooded.
+
 Known errors
 ************
 

docs/source/usage/4_develop.rst

@@ -165,17 +165,17 @@ If you want to output something to ansible's runtime - use 'module.warn':
 
     module.warn(f"{before} != {after}")
 
-You can also use the 'debug' argument to enable verbose output of the api requests. 
+You can also use the :code:`debug` argument to enable verbose output of the api requests.
 
 .. code-block:: yaml
 
     - name: Example
       ansibleguy.opnsense.alias:
         debug: true
 
-'Multi' modules also support the 'debug' parameter on a per-item basis - so you don't get flooded.
+'Multi' modules also support the :code:`debug` parameter on a per-item basis - so you don't get flooded.
 
-When the debug-mode is enabled some useful log files are created in the directory '/tmp/ansibleguy.opnsense'
+When the debug-mode is enabled some useful log files are created in the directory :code:`/tmp/ansibleguy.opnsense`
 
 .. code-block:: bash