Description
#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:
- doc/source/user_guide/10min.rst
- doc/source/user_guide/timeseries.rst
- doc/source/user_guide/visualization.rst
- doc/source/user_guide/missing_data.rst
- doc/source/user_guide/options.rst
- doc/source/user_guide/reshaping.rst
- doc/source/user_guide/scale.rst
- doc/source/user_guide/merging.rst
- doc/source/user_guide/cookbook.rst
- doc/source/user_guide/enhancingperf.rst
- doc/source/user_guide/groupby.rst
- doc/source/user_guide/io.rst
- doc/source/getting_started/overview.rst
- doc/source/reference/panel.rst
- doc/source/reference/plotting.rst
- doc/source/user_guide/basics.rst
- doc/source/user_guide/categorical.rst
- doc/source/development/contributing.rst
- doc/source/development/contributing_docstring.rst
- doc/source/development/extending.rst
- doc/source/ecosystem.rst
- doc/source/getting_started/comparison/comparison_with_sql.rst
- doc/source/getting_started/install.rst
- doc/source/getting_started/intro_tutorials/06_calculate_statistics.rst
- doc/source/getting_started/intro_tutorials/08_combine_dataframes.rst
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.