Corrected documentation on configuration

[a-takahashi223]

As mentioned in #606 (comment) , there are some errors in the configuration documentation.
This has been corrected.
Note that only the documentation has been corrected, not the man page or help messages.

[a-takahashi223]

Hello.

Is there any problem with this PR?
I am not a native English speaker, so English corrections are welcome.

[a-takahashi223]

Hi @ericwb @lukehinds @ghugo @sigmavirus24 ,

Am I violating the contribute guideline?

I read https://bandit.readthedocs.io/en/latest/config.html trying to get Bandit to ignore B101 and was very annoyed that it didn't work.
Others may have the same problem.

If such problems are reduced, Bandit, which is a great tool, will be easier to use.
Let me help you with that.

[sigmavirus24]

Am I violating the contribute guideline?

I don't see a violation here but I'm also carrying for my newborn child and not paying close attention. Did someone tell you that you were?

[a-takahashi223]

I'm also carrying for my newborn child

Congratulations on the birth of your baby. That must be very busy.

Did someone tell you that you were?

No, but this PR seems to be ignored, and I was concerned that the contribution guideline violation might be the reason.

[ericwb]

Looks mostly good, just open issue on the removal of the -p example.

[ericwb]

Bandit does still have an option to specify profiles to load via the -p or --profile argument.

[a-takahashi223]

I cloned PyCQA/bandit:main, ran python setup.py install and pip -r requirements.txt, then ran bandit examples/*.py -p ShellInjection. The output is below:

[main]  ERROR   Unable to find profile (ShellInjection) in config file: None

This result suggests that profile is not built-in, but something we define ourselves. So how do we define it?
Where is it written in the documentation?

[ericwb]

Yes, creating profiles is still possible via the bandit.yaml file. They are not built-in. And you can create a config yaml file bandit-config-generator

[a-takahashi223]

Thank you. I ran bandit-config-generator -o bandit.yaml then bandit examples/*.py -p ShellInjection -c bandit.yaml. The output is:

[main]  ERROR   Unable to find profile (ShellInjection) in config file: bandit.yaml

Again, how can I define profile in a configuration file?

After some trial and error, a configuration file as below finally worked.

profiles:
  ShellInjection:
    # ...

But I got the message below.

[config]        WARNING Config file 'bandit.yaml' contains deprecated legacy config data. Please consider upgrading to the new config format. The tool 'bandit-config-generator' can help you with this. Support for legacy configs will be removed in a future bandit version.

This is probably the best evidence that profile is deprecated and should not be used.
Therefore, all descriptions about profile should be removed from the documentation.

[sigmavirus24]

Even if it's "deprecated" (which it isn't) it shouldn't be removed in this pull request

[a-takahashi223]

I see. Reverted in 2d6cd55

[ericwb]

LGTM