Fixing documentation lists indentation (#21518)

[datapythonista]

• closes DOC: Fix indentation of lists in rst files #21518
• tests added / passed
• passes git diff upstream/master -u -- "*.py" | flake8 --diff
• whatsnew entry

[jreback]

• does this change the rendering anywhere?
• do you have a script to check this? (e.g. we can add to lint.sh)

[datapythonista]

There is a subtle change in the margins with the current template. The change is mainly to have a correct rendering with other markdowns that change the font of blockquotes.

With the current theme, it will make lists like the one in:

• https://pandas.pydata.org/pandas-docs/stable/overview.html#package-overview

Render with the margins of lists like:

• https://pandas.pydata.org/pandas-docs/stable/visualization.html#plotting-with-error-bars

The lists that currently have spaces before the * like the one in the overview page have a greater left indentation, that with this change will be removed. The resulting indentation will be the one in the visualization page.

I don't have any script that checks the rendering. Are you thinking on something for visual regression testing, or something simpler?

[jreback]

@datapythonista I meant a script to check the indentation of the lists. (checking rendering is extremely hard and out of scope)

[datapythonista]

Oh, I understand now, I mixed the two questions; Monday morning... :)

I did the changes looking for the indentation manually. I think a script is a good idea, not sure if it's trivial. I'll create a separate ticket for implementing the script if that's all right.

[jreback]

@datapythonista sure np.

[datapythonista]

Created #21520

[jorisvandenbossche]

Long time to do item of me to fix those indentations :-) So +1 !

My only question: I see you also have changed correct indentations but for switching - to *. I am not sure we should impose that? (it's not a restriction of the rst standard)

[datapythonista]

Ups, forgot to mention about using stars... In the first files I reviewed, all lists were using stars, so when I found the first hyphens I changed them for consistency, expecting to be very few cases. At the end there were many, so I think the change wasn't that much of a good idea, and just adds noise to the PR. But as I already changed them I didn't want to revert.

[jreback]

@jorisvandenbossche I put this on 0.23.2 as it other changes touch the docs might be a slight diff, but no big deal.

[jreback]

thanks @datapythonista

[jorisvandenbossche]

@jorisvandenbossche I put this on 0.23.2 as it other changes touch the docs might be a slight diff, but no big deal.

Yep, will decide on it when backporting