search

PyCQA / bandit

Bandit is a tool designed to find common security issues in Python code.
https://bandit.readthedocs.io
Apache License 2.0
6.5k stars 610 forks source link

Remove markdown formatting in reStructuredText formatted README #1103

Closed ericwb closed 10 months ago

ericwb commented 10 months ago

A recent change to the README has code blocks in markdown format. Since our README is actually reStructuredText format, this causes syntax errors.

It's even bigger of a problem when an attempt to publish the package with the README serving as the PyPI description. The syntax errors prevents package publishing.

Fixes #1102

ericwb commented 10 months ago

Note: I ran rstcheck README.rst before and after these changes to validate the fix.

Before:

README.rst:115: (ERROR/3) Unexpected indentation.
README.rst:113: (WARNING/2) Inline literal start-string without end-string.
README.rst:113: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.
README.rst:117: (WARNING/2) Block quote ends without a blank line; unexpected unindent.
README.rst:117: (WARNING/2) Inline literal start-string without end-string.
README.rst:117: (WARNING/2) Inline interpreted text or phrase reference start-string without end-string.
Error! Issues detected.

After: Success! No issues detected.