DOC: Improve widgets API documentation #30939
Open
+67
−13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
topic: widgets/UI
Documentation: API
Member
Author
QuLogic
reviewed
Jan 10, 2026
doc/api/widgets_api.rst
Outdated
| LassoSelector | ||
| PolygonSelector | ||
| SpanSelector | ||
| RadioButtons |
Member
There was a problem hiding this comment.
Radio buttons are related to check buttons, so I would put this after them.
| :show-inheritance: | ||
| Widget | ||
| AxesWidget | ||
| MultiCursor |
Member
There was a problem hiding this comment.
Also unsure why this isn't near plain Cursor?
- Structure the page into widgets and helpers. This requires explicit listing of the classes, but is bearable as we don't often add new classes - Limit the inheritance diagram to the Widget subclasses instead of also showning the helper classes there - Add documentation for `_SelectorWidget`. It's important to understand its subclasses. This also results in correctly showing the selector inheritance in the inheritance diagram
timhoffm
force-pushed
the
doc-widget-inheritance
branch
2 times, most recently
from
575891f to
2da7bc2
Compare
Member
Author
|
@QuLogic I initially just took over the order the classes were in in the code. Now I've completely reordered to:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current widgets API documentation is quite messy.
This PR improves this by:
_SelectorWidget. It's important to understand its subclasses. This also results in correctly showing the selector inheritance in the inheritance diagram