Description
The docs use certain coding style conventions that are no longer used in pandas (e.g., we adopt black's opinions in terms of line wrapping and quoting), for instance https://pandas.pydata.org/pandas-docs/stable/user_guide/merging.html. We should update the docs to match current style preferences.
blacken-docs is a useful tool that can help in doing some of this formatting, but it has to be used carefully since it might render lines that are too long and will fail flake8-rst checks, or it may not be able to parse certain files because of nuances in how the docs are written (raw output or magic commands in code blocks). One approach is to comment out the erring lines, let the tool handle all the others, then finish the commented lines manually.
Example cleanup: https://github.com/pandas-dev/pandas/pull/36700/files
List of files that need updating (if you submit a PR be sure to link back to this issue):
doc/source/development:
- code_style.rst
- contributing.rst
- contributing_docstring.rst
- developer.rst
- extending.rst
- index.rst
- internals.rst
- maintaining.rst
- meeting.rst
- policies.rst
- roadmap.rst
doc/source/getting_started/comparison:
- comparison_with_r.rst
- comparison_with_sas.rst
- comparison_with_sql.rst
- comparison_with_stata.rst
- index.rst
doc/source/getting_started/intro_tutorials:
- 01_table_oriented.rst
- 02_read_write.rst
- 03_subset_data.rst
- 04_plotting.rst
- 05_add_columns.rst
- 06_calculate_statistics.rst
- 07_reshape_table_layout.rst
- 08_combine_dataframe.rst
- 09_timeseries.rst
- 10_text_data.rst
doc/source/getting_started:
- index.rst
- install.rst
- overview.rst
- tutorials.rst
doc/source/user_guide:
- 10min.rst
- advanced.rst
- basics.rst
- boolean.rst
- categorical.rst
- computation.rst
- cookbook.rst
- dsintro.rst
- duplicates.rst
- enhancingperf.rst
- gotchas.rst
- groupby.rst
- index.rst
- integer_na.rst
- io.rst
- merging.rst
- missing_data.rst
- options.rst
- reshaping.rst
- scale.rst
- sparse.rst
- text.rst
- timedeltas.rst
- timeseries.rst
- visualization.rst