Black and docformatter don't agree on multiline string which starts with a "

[thejcannon]

Describe the style change

Given the following docstring, black shouldn't insert a leading space.

""""Cookie eaters" are the set of people that eat cookies."""

Examples in the current Black style

""" "Cookie eaters" are the set of people that eat cookies."""

Desired style

""""Cookie eaters" are the set of people that eat cookies."""

(Which is how docformatter leaves it)

Additional context

[JelleZijlstra]

We added the spacing on purpose to make the code clearer. Could docformatter change instead?

[thejcannon]

Perhaps, but I'd trust a tool dedicated to formatting docstrings's style over a tool for general Python code. Really the pain just comes from constant reformatting because of the conflict.

I did verify (on Python 3.8 at least) that the help with/without the space is equivalent. Likely a result of https://docs.python.org/3/library/inspect.html#inspect.cleandoc

[thejcannon]

Looks like there's a standing issue: PyCQA/docformatter#39

[thejcannon]

I also think I like the black style better. Just hate being in formatting limbo 🥴

[ghost]

IMO if there's a space on the left side there should be one on the right side too, otherwise it looks inconsistent. But not having a space at all also looks weird.

[weibullguy]

I've been cleaning up the docformatter open issues and PRs. I just opened #94 to add an argument (e.g., --black) to allow both tools to behave themselves when used together. Poking around the black code, I see you're following PEP 257 for docstring indentation (which should be compatible already) in addition to the formatting @thejcannon pointed out. If there is any other docstring formatting black does, I'd appreciate it if you dropped a comment in the above referenced issue so I can address everything at once. TIA

[felix-hilden]

I agree that separating the quotes looks nicer. Since it's being fixed on their side, are we good to close this issue?