Code

Opened 5 years ago

Closed 5 years ago

Last modified 3 years ago

#10329 closed (fixed)

link "get_FOO_display()" in model field reference

Reported by: rctay Owned by: nobody
Component: Documentation Version: 1.0
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 second last paragraph of the "choices" section under "Field options", the method "get_FOO_display" is mentioned, and the user is told to look for this in the "database API documentation".

Currently, this text in not linked to anything, and the "database API" may be confusing to newcomers who may try to search for this in django's documentation, when he/she should be looking in the model API.

It would be very helpful to newcomers to django to find out more about this method if it were linked to the method's documentation, namely, at, http://docs.djangoproject.com/en/dev/ref/models/instances/#get-foo-display.

Attachments (1)

get_FOO_display-link.diff (1.5 KB) - added by timo 5 years ago.
linking get_FOO_display, plus a stray colon deleted

Download all attachments as: .zip

Change History (7)

comment:1 Changed 5 years ago by jacob

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

Changed 5 years ago by timo

linking get_FOO_display, plus a stray colon deleted

comment:2 Changed 5 years ago by timo

  • Triage Stage changed from Accepted to Ready for checkin

comment:3 Changed 5 years ago by anonymous

  • Has patch set

comment:4 Changed 5 years ago by russellm

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

(In [10152]) Fixed #10329 -- Added link target for get_FOO_display, get_next_by_FOO, and get_previous_by_FOO. Thanks to rctay for the report, and timo for the patch.

comment:5 Changed 5 years ago by russellm

(In [10160]) [1.0.X] Fixed #10329 -- Added link target for get_FOO_display, get_next_by_FOO, and get_previous_by_FOO. Thanks to rctay for the report, and timo for the patch.

Merge of r10152 from trunk.

comment:6 Changed 3 years ago by jacob

  • milestone 1.1 deleted

Milestone 1.1 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.