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.

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

Closed
3 tasks
AlexWaygood opened this issue Jan 15, 2022 · 4 comments · Fixed by #154
Closed
3 tasks

Either convert .rst files to markdown, or add an rst linting script to CI #73

AlexWaygood opened this issue Jan 15, 2022 · 4 comments · Fixed by #154

Comments

@AlexWaygood
Copy link
Collaborator

AlexWaygood commented Jan 15, 2022

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:

@AlexWaygood AlexWaygood changed the title Either convert .rst files to markdown, or run an rst linting script Either convert .rst files to markdown, or add an rst linting script to CI Jan 15, 2022
@Akuli
Copy link
Collaborator

Akuli commented Jan 16, 2022

I think we should just use markdown, because we are more familiar with its syntax and won't make silly errors.

@AlexWaygood
Copy link
Collaborator Author

I think we should just use markdown, because we are more familiar with its syntax and won't make silly errors.

I agree.

@KotlinIsland
Copy link
Contributor

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.

@AlexWaygood
Copy link
Collaborator Author

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants