Opened 7 years ago

Closed 7 years ago

Last modified 5 years ago

#12114 closed (fixed)

re Tutorial pt 1 "Playing with the API"

Reported by: panfist Owned by: Derek Willis
Component: Documentation Version: 1.1
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

In the tutorial part 1, In the later part of the "playing with the api" section, an attribute is invoked called choice_set. Now, it's my understanding after some discussion on IRC that foo_set is a magical attributed generated from reverse relations. I think this needs to be mentioned in the tutorial, or a link provided to the more comprehensive documentation. My main reasoning is that the only clue the reader has to go by is the word "set" which won't produce useful search results. Thanks.

Attachments (1)

12114.patch (2.1 KB) - added by Derek Willis 7 years ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 7 years ago by Russell Keith-Magee

milestone: 1.2
Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Triage Stage: UnreviewedAccepted

Changed 7 years ago by Derek Willis

Attachment: 12114.patch added

comment:2 Changed 7 years ago by Derek Willis

Has patch: set
Owner: changed from nobody to Derek Willis
Status: newassigned

Taking a stab at this, although the way the example is set up, I could also see creating the Choice objects independently and then explaining how the API is used to access related objects in both directions.

comment:3 Changed 7 years ago by Tim Graham

Triage Stage: AcceptedReady for checkin

comment:4 Changed 7 years ago by Russell Keith-Magee

Resolution: fixed
Status: assignedclosed

(In [12711]) Fixed #12114 -- Clarified the existence of the reverse relation _set in the tutorial. Thanks to panfist for the suggestion, and dwillis for the patch.

comment:5 Changed 7 years ago by Russell Keith-Magee

(In [12714]) [1.1.X] Fixed #12114 -- Clarified the existence of the reverse relation _set in the tutorial. Thanks to panfist for the suggestion, and dwillis for the patch.

Backport of r12711 from trunk.

comment:6 Changed 5 years ago by Jacob

milestone: 1.2

Milestone 1.2 deleted

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