Skip to content

Fails for non-standard docstrings #172

@akaszynski

Description

@akaszynski

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions