-
-
Notifications
You must be signed in to change notification settings - Fork 606
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix README.rst #365
Fix README.rst #365
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So the filename does need to be called .bandit. By stating here only to include a YAML file doesn't tell the user what it should be named.
The current README.rst has references to configure bandit runs using a custom .INI-like file. In reality, that file should actually be a YAML file. Using the INI example provided will result in: ` [main] ERROR bandit.cfg : Error parsing file. ` This patch set updates the configuration so it is of proper YAML format so the execution will not error out. Signed-off-by: Tin Lam <tinlam@gmail.com>
Added back the name of the file into README.rst. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The .bandit file is INI. A YAML file can be passed to the -c option to the CLI with is more for configuring test plugins.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
The current README.rst has references to configure bandit runs using a custom
.INI-like file. In reality, that file should actually be a YAML file.
Using the INI example provided will result in:
[main] ERROR bandit.cfg : Error parsing file.
This patch set updates the configuration so it is of proper YAML format so
the execution will not error out.
Signed-off-by: Tin Lam tinlam@gmail.com