Opened 7 weeks ago

Closed 2 weeks ago

Last modified 2 weeks ago

#37194 closed Cleanup/optimization (fixed)

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: Ready for checkin
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 (12)

comment:1 by Natalia Bidart, 7 weeks ago

Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization

Sounds good, thanks!

comment:2 by Natalia Bidart, 7 weeks ago

Summary: Update Choice widget documentation to reflect current class heirarchyUpdate Choice widget documentation to reflect current class hierarchy

comment:3 by maheen8q, 6 weeks ago

Owner: set to maheen8q
Status: newassigned

comment:4 by maheen8q, 6 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 maheen8q, 6 weeks ago

Has patch: set

comment:6 by maheen8q, 6 weeks ago

Last edited 6 weeks ago by maheen8q (previous) (diff)

comment:7 by blighj, 3 weeks ago

Triage Stage: AcceptedReady for checkin

comment:8 by Sarah Boyce, 3 weeks ago

Patch needs improvement: set
Triage Stage: Ready for checkinAccepted

comment:9 by Sarah Boyce, 2 weeks ago

Patch needs improvement: unset
Triage Stage: AcceptedReady for checkin

comment:10 by Sarah Boyce <42296566+sarahboyce@…>, 2 weeks ago

Resolution: fixed
Status: assignedclosed

In e1feeee:

Fixed #37194 -- Removed redundant choice widget documentation.

The removed section primarily provided usage examples and recommendations
rather than documenting the widget API. The interaction between a choice
field and its widget is already documented in the Select.choices reference.

comment:11 by Sarah Boyce <42296566+sarahboyce@…>, 2 weeks ago

In df502a7:

[6.1.x] Fixed #37194 -- Removed redundant choice widget documentation.

The removed section primarily provided usage examples and recommendations
rather than documenting the widget API. The interaction between a choice
field and its widget is already documented in the Select.choices reference.

Backport of e1feeee45ea8bcd4325554c9b94fcd75fcd8dbdc from main.

comment:12 by Sarah Boyce <42296566+sarahboyce@…>, 2 weeks ago

In 9ff89f1:

[6.0.x] Fixed #37194 -- Removed redundant choice widget documentation.

The removed section primarily provided usage examples and recommendations
rather than documenting the widget API. The interaction between a choice
field and its widget is already documented in the Select.choices reference.

Backport of e1feeee45ea8bcd4325554c9b94fcd75fcd8dbdc from main.

Note: See TracTickets for help on using tickets.
Back to Top