Use a table format for list of plugins #872
Conversation
|
|
| :glob: | ||
|
|
||
| * | ||
| .. table:: Active Test Plugins |
There was a problem hiding this comment.
This looks prone to merge conflict problems and seems to remove the error code from the specific plugin documentation page.
If we don't care about merge conflicts running rampant, we can do
B101 :doc:`assert_unused <b101_assert_used>` Low HighTo not show the error code in the name if we want without losing the error code on the plugin's page... unless we specifically want to start migrating away from the short code format
There was a problem hiding this comment.
I originally used the technique you describe, but the width of the lines became obscenely long. I also noticed that each plugin's doc already denotes the bandit ID anyway as their first line like so:
B501: Test for missing certificate validation
So it's already a bit redundant today in how it appears. For example:
https://bandit.readthedocs.io/en/1.7.4/plugins/b501_request_with_no_cert_validation.html
Rather than showing the plugins as a simple list, this change puts them into a table. It also clearly separates active vs. removed plugins for clarity. Also discovered as part of this change was that snmp_weak_cryptography plugin doc file was incorrectly named with the duplicate ID of 508 instead of 509 as it should be. Signed-off-by: Eric Brown <[email protected]>
doc/source/plugins/b602_subprocess_popen_with_shell_equals_true.rst
Outdated
Show resolved
Hide resolved
doc/source/plugins/b602_subprocess_popen_with_shell_equals_true.rst
Outdated
Show resolved
Hide resolved
Rather than showing the plugins as a simple list, this change
puts them into a table. It also clearly separates active vs.
removed plugins for clarity.
Also discovered as part of this change was that snmp_weak_cryptography
plugin doc file was incorrectly named with the duplicate ID of 508
instead of 509 as it should be.
Signed-off-by: Eric Brown [email protected]