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

audeer.deprecated() interferes with the docs #145

Open
hagenw opened this issue Apr 19, 2024 · 1 comment
Open

audeer.deprecated() interferes with the docs #145

hagenw opened this issue Apr 19, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@hagenw
Copy link
Member

hagenw commented Apr 19, 2024

E.g. assume we have the following class definition:

@audeer.deprecated(removal_version="2.2.0")
class Repository:
    r"""Repository object.
    ...
    """

    def __init__(
        self,
        name: str,
        host: str,
        backend: str,
    ):  
        # ...

when including this in an API documentation it results in

image

instead of the expected

image

@hagenw hagenw added the bug Something isn't working label Apr 19, 2024
@hagenw
Copy link
Member Author

hagenw commented Apr 19, 2024

In addition, it prevents class attributes to show up in the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant