coala / coala/projects

Project proposal: lint rst single vs double backticks

Open
#391 2 comments 0 reactions 2 assignees Claimed by @ankitxjoshi View on GitHub
Project Proposal
Dominant language
JavaScript
Stars
118
Forks
225
PR merge metrics
No merged PRs in 30d

Description

There isnt any clear guidance on single vs double backticks in RST, especially when RST is not embedded within Python, however a rule of thumb is that single backticks should be implicit references to something.

https://stackoverflow.com/questions/22256995/restructuredtext-in-sphinx-and-docstrings-single-vs-double-back-quotes-or-back
https://mail.zope.org/pipermail/grok-dev/2008-December/006823.html

For documentation especially, it would be helpful to have a checker that finds a section heading somewhere in the docs for anything in single backticks, and errors if it cant be found.

https://github.com/myint/rstcheck would likely be the best spot for this to be implemented.

And https://github.com/myint/rstcheck/issues/32 would be an ideal task to be done to familiarise oneself with the project.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.