diff --git a/README.rst b/README.rst index d7ce78351..a0ae2937b 100644 --- a/README.rst +++ b/README.rst @@ -142,26 +142,28 @@ An optional config file may be supplied and may include: Per Project Command Line Args ----------------------------- -Projects may include a `.bandit` file that specifies command line arguments -that should be supplied for that project. The currently supported arguments -are: +Projects may include a YAML file named `.bandit` that specifies command line +arguments that should be supplied for that project. The currently supported +arguments are: - targets: comma separated list of target dirs/files to run bandit on - exclude: comma separated list of excluded paths - skips: comma separated list of tests to skip - tests: comma separated list of tests to run -To use this, put a .bandit file in your project's directory. For example: +To use this, put a YAML file named `.bandit` in your project's directory. +For example: :: - [bandit] exclude: /test :: - [bandit] - tests: B101,B102,B301 + tests: + - B101 + - B102 + - B301 Exclusions