Skip to content

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

Closed
16 of 25 tasks
dsaxton opened this issue Sep 25, 2020 · 5 comments · Fixed by #36632
Closed
16 of 25 tasks

DOC: Replace single with double backticks in RST files #36617

dsaxton opened this issue Sep 25, 2020 · 5 comments · Fixed by #36632

Comments

@dsaxton
Copy link
Member

dsaxton commented Sep 25, 2020

#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.

@dsaxton dsaxton added this to the Contributions Welcome milestone Sep 25, 2020
@satrio-hw
Copy link
Contributor

Hi @dsaxton , I would like take this issue, can I?

@kaptajnen
Copy link
Contributor

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.

@satrio-hw
Copy link
Contributor

Than I'll take :

  • doc/source/development/contributing.rst
  • doc/source/development/contributing_docstring.rst
  • doc/source/development/extending.rst
  • doc/source/ecosystem.rst
  • doc/source/getting_started/install.rst
  • doc/source/getting_started/comparison/comparison_with_sql.rst
  • doc/source/getting_started/intro_tutorials/06_calculate_statistics.rst
  • doc/source/getting_started/intro_tutorials/08_combine_dataframes.rst
  • doc/source/user_guide/categorical.rst

@Shubhamsm
Copy link
Contributor

if some files still left to fix I've made a PR #36632

@dsaxton
Copy link
Member Author

dsaxton commented Sep 25, 2020

Hi @dsaxton , I would like take this issue, can I?

Sure, feel free to simply open a PR (which it looks like you've done)

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.

4 participants