-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Replace single with double backticks in RST files #36617
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
Labels
Comments
Hi @dsaxton , I would like take this issue, can I? |
kaptajnen
added a commit
to kaptajnen/pandas
that referenced
this issue
Sep 25, 2020
I have added a PR to fix a few of the files. There are still more that needs to be fixed in case anyone else wants to help. |
Than I'll take :
|
if some files still left to fix I've made a PR #36632 |
Sure, feel free to simply open a PR (which it looks like you've done) |
5 tasks
dsaxton
pushed a commit
that referenced
this issue
Sep 26, 2020
kesmit13
pushed a commit
to kesmit13/pandas
that referenced
this issue
Nov 2, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
#36591 added a pre-commit hook for flagging the use of single instead of double backticks for code blocks in restructured text. This is a pretty common mistake in the docs so a lot of files have to be skipped, but we should instead remove these exclusions and fix the relevant files.
Note that this might mean removing rather than adding backticks if the text is not actual code. Also certain linked references require single backticks, see https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#xref-syntax.
In addition to most release notes these files all have errors:
Easiest worfklow for fixing is probably to install the pre-commit hooks, delete exclusions from https://github.com/pandas-dev/pandas/blob/master/.pre-commit-config.yaml, run
pre-commit run rst-backticks --all-files
, fix the errors and then commit. Any PRs can link back to this issue we'll cross things off when merged.The text was updated successfully, but these errors were encountered: