Provide deterministic URLs with description of tests
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.3k
- Forks
- 835
- Avg merge
- 5d 3h
- Merged PRs (30d)
- 1
Description
Is your feature request related to a problem? Please describe.
I would like to make it easier for users to fix encountered warnings.
Describe the solution you'd like
Provide documentation of tests with deterministic URLs based on the ID.
This could be https://bandit.readthedocs.io/en/latest/blacklists/index.html#complete-plugin-listing#Bxxx.
Current URLs like https://bandit.readthedocs.io/en/latest/blacklists/blacklist_calls.html#b301-pickle cannot easily be generated because of the headline part -pickle and different pages for B3xx and B4xx errors.
Describe alternatives you've considered
Let the user figure out themselves how to fix the error.
Additional context
None
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the documented blacklist pages at docs/blacklists/index.html and the current blacklist_calls.html examples to understand how test descriptions and anchors are presented. Done means warnings can point to deterministic ID-based URLs, with the documentation covering the Bxxx format and the B3xx/B4xx page difference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100