Revert "Remove descriptions about "profile""

This reverts commit c4b2d52.
PyCQA · Apr 23, 2022 · 2d6cd55 · 2d6cd55
1 parent c4b2d52
commit 2d6cd55
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/doc/source/config.rst b/doc/source/config.rst
@@ -78,7 +78,7 @@ look like the following:
 
 .. code-block:: yaml
 
-  ### configuration may optionally select or skip tests
+  ### profile may optionally select or skip tests
 
   # (optional) list included tests here:
   tests: ['B201', 'B301']

diff --git a/doc/source/start.rst b/doc/source/start.rst
@@ -40,6 +40,11 @@ context and only reporting on the high-severity issues::
 
     bandit examples/*.py -n 3 -lll
 
+Bandit can be run with profiles. To run Bandit against the examples directory
+using only the plugins listed in the ``ShellInjection`` profile::
+
+    bandit examples/*.py -p ShellInjection
+
 Bandit also supports passing lines of code to scan using standard input. To
 run Bandit with standard input::