Opened 3 weeks ago
Last modified 2 weeks ago
#37194 assigned Cleanup/optimization
Update Choice widget documentation to reflect current class hierarchy
| Reported by: | David Smith | Owned by: | maheen8q |
|---|---|---|---|
| Component: | Documentation | Version: | 6.0 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
The documentation has a section called "Widgets inheriting from the Select widget", see docs. It then goes on to talk about choice widgets including both Select and RadioSelect inputs.
Since 9ac4dbd7b53d187ca54f28e247d3a120660938ca not all choice widgets inherit from the Select widget. Currently, both Select and RadioSelect are subclasses of the undocumented ChoiceWidget.
I've drafted a possible patch for discussion
Widgets with choices ==================== There are a group of widgets which deal with choices and present the user with a list of options to choose from. The different widgets present this choice differently; the :class:`Select` widget uses a ``<select>`` HTML list representation, while :class:`RadioSelect` uses radio buttons and :class:`CheckboxSelectMultiple` uses checkboxes.
Change History (6)
comment:1 by , 3 weeks ago
| Triage Stage: | Unreviewed → Accepted |
|---|---|
| Type: | Uncategorized → Cleanup/optimization |
comment:2 by , 3 weeks ago
| Summary: | Update Choice widget documentation to reflect current class heirarchy → Update Choice widget documentation to reflect current class hierarchy |
|---|
comment:3 by , 2 weeks ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
comment:4 by , 2 weeks ago
I'd like to work on this. I'll update the section title and description in the widget docs to reflect the current class hierarchy as suggested in the description.
comment:5 by , 2 weeks ago
| Has patch: | set |
|---|
Sounds good, thanks!