-
Notifications
You must be signed in to change notification settings - Fork 814
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
[docs] Inherit documentation for some objects #3079
Comments
In most objects, there is a small section So, the actual issues appear to be a lack of total documentation. That is, missing documentation for ToggleButton, no examples for many layouts, etc. Nothing specific to be done here, just would be useful for better documentation. Close? |
The point here though is that ToggleButton is really an internal implementation detail, so it would be better if the child classes were fully documented without it needing to appear in the docs. |
Sorry, I guess I don't understand. Functionally, the only method from ToggleButton that is Toggle() which should not be exposed as it returns an internal class, and has not functionality beyond What is missing, all through the documentation, are descriptions about styling rules, as in what is really available and what applies to each widget. It feels like there should be a rewrite of The current Additionally, I would like to see more a more complete version, including the rule and location that causes the value of each setting. That is, Finally, I want a version that goes "up", giving rules for each parent going up as a way of diagnosing CSS errors. In practice, the most I would seriously commit to is to write an example and documentation for |
Things like the
Checkbox
API documentation are missing lots of information because they inherit most of their behaviour (fromToggleButton
, 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
The text was updated successfully, but these errors were encountered: