blackdoc icon indicating copy to clipboard operation
blackdoc copied to clipboard

Fails for non-standard docstrings

Open akaszynski opened this issue 2 years ago • 2 comments

First off, great repository. Thanks for your work!

Now to the issue: Within PyVista, we have a decorator: https://github.com/pyvista/pyvista/blob/451b61c09bbf56f9a55d8e1176986fae361dd7ea/pyvista/plotting/charts.py#L64

This allows us to substitute values in our documentation: https://github.com/pyvista/pyvista/blob/a26a52d037a265774be0ca06bb141e3346e73ad0/pyvista/plotting/charts.py#L1773-L1781

However, this is incompatible with blackdoc. We either need a workaround that permits the use of this decorator or we need to allow substitution (a hard edge case to build for).

akaszynski avatar Mar 13 '23 14:03 akaszynski

the way we did that for xarray was to ignore the file entirely. Not sure if that's possible for you, though.

Otherwise, we could have blackdoc skip over lines ending with # fmt: skip (or code blocks containing it). I'm not sure when I will have the time to do so, but I'll look into it.

keewis avatar Mar 15 '23 14:03 keewis

ignore the file entirely

We're doing that now for this file. Thanks!

akaszynski avatar Mar 17 '23 14:03 akaszynski