-
Notifications
You must be signed in to change notification settings - Fork 23
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.
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
Either convert .rst
files to markdown, or add an rst
linting script to CI
#73
Comments
.rst
files to markdown, or run an rst
linting script.rst
files to markdown, or add an rst
linting script to CI
I think we should just use markdown, because we are more familiar with its syntax and won't make silly errors. |
I agree. |
I fixed a bunch more in #117, I'm completely unfamiliar with rst but the support in PyCharm (syntax highlighting and preview window) made it extremely easy to work with. |
Thank you very much! |
Silly
rst
markup errors aren't being caught by the CI (e.g. #72 fixes a bunch that look like they've been there for a while).We should probably either convert these files to markdown, or add linting script like CPython's
rstlint.py
to the CI.Files that need to be ported are:
README.rst
: Port the README to markdown #152CHANGELOG.rst
: PortCHANGELOG.rst
to markdown #153CONTRIBUTING.rst
: PortCONTRIBUTING.rst
to markdown #154The text was updated successfully, but these errors were encountered: