Skip to content

[docs] Inherit documentation for some objects #3079

Open
@rodrigogiraoserrao

Description

@rodrigogiraoserrao

Things like the Checkbox API documentation are missing lots of information because they inherit most of their behaviour (from ToggleButton, in this case).
What is worse, ToggleButton isn't even publicly documented.

But even if it was, you'd have one level of indirection that is very easy to miss: you have to remember to check if a widget has a base class more specific than just Widget.

I suspect for things like Checkbox/RadioButton, and possibly other things, it would be helpful to inherit the documentation from the immediate base class.

C.f. inherited members option in mkdocstrings

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions