Opened 7 years ago

Last modified 7 years ago

#28352 closed Cleanup/optimization

QuerySet.values_list() docs documentation doesn't show correct return type — at Version 2

Reported by: Rich Elmes Owned by: nobody
Component: Documentation Version: 1.11
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: yes UI/UX: no

Description (last modified by Tim Graham)

The values() documentation (docs/ref/models/querysets.txt) correctly shows the return type of the object:

>>> Entry.objects.values()
<QuerySet [{'blog_id': 1, 'headline': 'First Entry', ...}, ...]>

whereas the values_list() erroneously shows the return type as a list:

>>> Entry.objects.values_list('id', 'headline')
[(1, 'First entry'), ...]

Simply wrapping <QuerySet> around the list shown might save others getting as confused as I did.

Change History (2)

comment:1 by Rich Elmes, 7 years ago

Summary: values_list documentation doesn't show return type which can be confusing → values_list documentation doesn't show correct return type which can be confusing

comment:2 by Tim Graham, 7 years ago

Description: modified (diff)
Easy pickings: set
Summary: values_list documentation doesn't show correct return type which can be confusing → QuerySet.values_list() docs documentation doesn't show correct return type
Triage Stage: Unreviewed → Accepted
Note: See TracTickets for help on using tickets.
Back to Top