From 207a4e88d522b38761c79e28372c3b4798b86270 Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Sat, 19 Feb 2022 16:40:43 -0800 Subject: [PATCH] Fix up some warnings and errors in docs * Some lines missing code-block * Missing blank lines for spacing Signed-off-by: Eric Brown --- bandit/plugins/app_debug.py | 2 +- bandit/plugins/snmp_security_check.py | 1 + bandit/plugins/yaml_load.py | 3 ++- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/bandit/plugins/app_debug.py b/bandit/plugins/app_debug.py index fba17052b..3b18996fe 100644 --- a/bandit/plugins/app_debug.py +++ b/bandit/plugins/app_debug.py @@ -33,7 +33,7 @@ .. [1] https://flask.palletsprojects.com/en/1.1.x/quickstart/#debug-mode .. [2] https://werkzeug.palletsprojects.com/en/1.0.x/debug/ .. [3] https://labs.detectify.com/2015/10/02/how-patreon-got-hacked-publicly-exposed-werkzeug-debugger/ - .. [4] https://cwe.mitre.org/data/definitions/94.html + .. https://cwe.mitre.org/data/definitions/94.html .. versionadded:: 0.15.0 diff --git a/bandit/plugins/snmp_security_check.py b/bandit/plugins/snmp_security_check.py index 1d207cdec..a915ed898 100644 --- a/bandit/plugins/snmp_security_check.py +++ b/bandit/plugins/snmp_security_check.py @@ -20,6 +20,7 @@ def snmp_insecure_version_check(context): :Example: .. code-block:: none + >> Issue: [B508:snmp_insecure_version_check] The use of SNMPv1 and SNMPv2 is insecure. You should use SNMPv3 if able. Severity: Medium Confidence: High diff --git a/bandit/plugins/yaml_load.py b/bandit/plugins/yaml_load.py index dec77ee26..acd67d727 100644 --- a/bandit/plugins/yaml_load.py +++ b/bandit/plugins/yaml_load.py @@ -19,6 +19,8 @@ :Example: +.. code-block:: none + >> Issue: [yaml_load] Use of unsafe yaml load. Allows instantiation of arbitrary objects. Consider yaml.safe_load(). Severity: Medium Confidence: High @@ -28,7 +30,6 @@ 5 y = yaml.load(ystr) 6 yaml.dump(y) - .. seealso:: - https://pyyaml.org/wiki/PyYAMLDocumentation#LoadingYAML