The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Hi @manueldeprada

I won't be available to review until next Friday.

BTW, do you mean the issue you found for

#38915 (comment)

Yes, that one. Enjoy!! Its minor, it can wait for a week :)

@ydshieh gentle ping on this 🤗 Btw, I have successfully fixed a few docstrings using the new version :)

Thanks for diving into this!

One question:

obj.doc attribute. Python automatically un-indents the string provided by doc

Is this always? Because if so, we should have troubles at many places (before this PR) no? But we only have seen a few places.

It only affects the fixing mode, not the checks on the docstring. I guess devs have got used to fixing the docs manually (we can ask).

Every time I had to fix a doc issue in my cache refactor this issue happened, and I had to either cherry pick this or fix the docstring manually.

Also, If a docstring is placed at root level indentation, there is no difference. But it is indeed a consistent behaviour:

>>> def f():
...     """
...     Hello
...          World
...     """
...     
>>> repr(f.__doc__)
"'\\nHello\\n     World\\n'"
>>> import inspect
>>> inspect.getsourcelines(f)[0]
['def f():\n', '    """\n', '    Hello\n', '         World\n', '    """\n']