Skip to content

Fix README.rst#365

Merged
ericwb merged 4 commits into
PyCQA:masterfrom
stannum-l:doc-fix
Jan 25, 2022
Merged

Fix README.rst#365
ericwb merged 4 commits into
PyCQA:masterfrom
stannum-l:doc-fix

Conversation

@stannum-l
Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Member

@ericwb ericwb left a 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.

@ericwb
Copy link
Copy Markdown
Member

ericwb commented Aug 14, 2018

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>
@stannum-l
Copy link
Copy Markdown
Contributor Author

Added back the name of the file into README.rst.

Copy link
Copy Markdown
Member

@ericwb ericwb left a 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.

Copy link
Copy Markdown
Member

@ericwb ericwb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants