Skip to content

Python bindings for the library currently lack docstrings at the class level #2968

@arjo129

Description

@arjo129

Desired behavior

While individual functions and methods within the Python binding classes are properly documented with docstrings, the classes themselves do not have corresponding docstrings. This omission hinders the discoverability and understanding of the API for users who rely on Python's built-in help() function or IDE features like autocompletion and hover information. Without class-level docstrings, users must refer to external documentation, which can be less convenient and may not always be up-to-date.

Alternatives considered

Implementation suggestion

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    Inbox

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions