Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fails for non-standard docstrings #172

Open
akaszynski opened this issue Mar 13, 2023 · 2 comments
Open

Fails for non-standard docstrings #172

akaszynski opened this issue Mar 13, 2023 · 2 comments

Comments

@akaszynski
Copy link

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).

@keewis
Copy link
Owner

keewis commented Mar 15, 2023

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.

@akaszynski
Copy link
Author

akaszynski commented Mar 17, 2023

ignore the file entirely

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants