Code

Opened 4 years ago

Closed 4 years ago

Last modified 3 years ago

#12114 closed (fixed)

re Tutorial pt 1 "Playing with the API"

Reported by: panfist Owned by: dwillis
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 dwillis 4 years ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 4 years ago by russellm

  • milestone set to 1.2
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Changed 4 years ago by dwillis

comment:2 Changed 4 years ago by dwillis

  • Has patch set
  • Owner changed from nobody to dwillis
  • Status changed from new to assigned

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 4 years ago by timo

  • Triage Stage changed from Accepted to Ready for checkin

comment:4 Changed 4 years ago by russellm

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

(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 4 years ago by russellm

(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 3 years ago by jacob

  • milestone 1.2 deleted

Milestone 1.2 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.