Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Missing documentation on the custom formatter #406

Closed
ericwb opened this issue Oct 19, 2018 · 1 comment
Closed

Missing documentation on the custom formatter #406

ericwb opened this issue Oct 19, 2018 · 1 comment
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@ericwb
Copy link
Member

ericwb commented Oct 19, 2018

Describe the bug
The custom formatter added under commit d159335 doesn't have anything documented in the docs here: https://bandit.readthedocs.io/en/latest/formatters/index.html

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://bandit.readthedocs.io/en/latest/formatters/index.html
  2. Notice a custom formatter is not listed

Expected behavior
Should have a link for custom

Bandit version
master

Additional context
@ericwb ericwb added the bug Something isn't working label Oct 27, 2018
@lukehinds lukehinds added the good first issue Good for newcomers label Nov 1, 2018
@nixphix
Copy link
Contributor

nixphix commented Nov 6, 2018

Let me fix it

nixphix added a commit to nixphix/bandit that referenced this issue Nov 6, 2018
@nixphix
Add missing custom formatter doc (PyCQA#406)
6f2789d 
* Add custom.rst to docs source
* Fix custom formatter docstring
@nixphix nixphix mentioned this issue Nov 6, 2018
Merged
ericwb pushed a commit that referenced this issue Nov 27, 2018
@nixphix @ericwb
Add missing custom formatter doc (#406) (#421)
fe1c116 
* Add missing custom formatter doc (#406)

* Add custom.rst to docs source
* Fix custom formatter docstring
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@nixphix @ericwb @lukehinds