Opened 3 years ago

Closed 3 years ago

#17929 closed Cleanup/optimization (fixed)

Tutorial improvements for "Choice", "choice", and "choice": choice_text & capitalization

Reported by: rmattb Owned by: nobody
Component: Documentation Version: master
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

Choice, choice, and choice are kinda ambiguous to the new tutorial reader. :)
To improve the distinctions between these:

  • the Choice model
  • the real-world idea of making a choice in a poll
  • the literal text of each specific choice

I've spelled out what the existing tutorial calls "the text of the choice" by extending the name of the attribute "choice" to "choice_text".

Patch and updated screenshots attached. :)

Attachments (5)

17929.tutorial-attribute-choice_text.diff (4.0 KB) - added by rmattb 3 years ago.
admin10.png (11.4 KB) - added by rmattb 3 years ago.
admin11t.png (32.5 KB) - added by rmattb 3 years ago.
admin12.png (11.1 KB) - added by rmattb 3 years ago.
17929.tutorial-choice-object-capitalized.diff (4.9 KB) - added by rmattb 3 years ago.

Download all attachments as: .zip

Change History (8)

Changed 3 years ago by rmattb

Changed 3 years ago by rmattb

Changed 3 years ago by rmattb

Changed 3 years ago by rmattb

comment:1 Changed 3 years ago by rmattb

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Summary changed from Tutorial improvement for "Choice", "choice", and "choice": choice_text to Tutorial improvements for "Choice", "choice", and "choice": choice_text & capitalization

Further followed the existing pattern of capitalizing and using backquotes for class names Choice and Poll. Attached another patch for this.

comment:2 Changed 3 years ago by jezdez

  • Triage Stage changed from Unreviewed to Ready for checkin

comment:3 Changed 3 years ago by Claude Paroz <claude@…>

  • Resolution set to fixed
  • Status changed from new to closed

In [45284a90a515e71552f37c539a3cfdc38f15d869]:

Fixed #17929 -- Improved tutorial wording and capitalization.

Thanks rmattb for the report and the patch.

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