Opened 6 years ago

Closed 6 years ago

Last modified 5 years ago

#13538 closed (fixed)

Clarifications for http://docs.djangoproject.com/en/dev/topics/db/queries/

Reported by: yipengh87@… 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 (last modified by Karen Tracey)

The referenced class uses a capital E....
class Entry(models.Model)

But under "Saving ForeignKey and ManyToManyField fields",
a small E is used...

>>> entry.blog = cheese_blog
>>> entry.save()

Before the above line can be executed, there is also a missing import statement...

>>> from mysite.blog.models import *

Attachments (2)

13538.diff (1.5 KB) - added by Derek Willis 6 years ago.
13538.2.diff (1.3 KB) - added by Tim Graham 6 years ago.
updating existing patch to fix syntax highlighting

Download all attachments as: .zip

Change History (11)

comment:1 Changed 6 years ago by Karen Tracey

Description: modified (diff)
Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Summary: Mistakes in http://docs.djangoproject.com/en/dev/topics/db/queries/Clarificications for http://docs.djangoproject.com/en/dev/topics/db/queries/
Triage Stage: UnreviewedAccepted

(Fixed description formatting. Please use preview.)

The text in question is here: http://docs.djangoproject.com/en/dev/topics/db/queries/#saving-foreignkey-and-manytomanyfield-fields

The Entry/entry difference is not an error in the documentation. The lowercase-e entry is assumed to be an instance of the Entry class. The previous section on saving changes to an object makes that clear by noting what b5 is before using it in the example code, it would probably make sense to avoid confusion and note something similar before entry is used.

The page does show an import for Blog, but not the other models used. In reading through the text, though, it's clear that the Blog import is done to show an example of how to do it; the remaining text assumes corresponding imports have been done for the other models used. It might not hurt to point that out in the text.

comment:2 Changed 6 years ago by Derek Willis

Owner: changed from nobody to Derek Willis
Status: newassigned

Changed 6 years ago by Derek Willis

Attachment: 13538.diff added

comment:3 Changed 6 years ago by Derek Willis

Has patch: set
milestone: 1.3

Added patch with some clarifications and additional imports.

Changed 6 years ago by Tim Graham

Attachment: 13538.2.diff added

updating existing patch to fix syntax highlighting

comment:4 Changed 6 years ago by Tim Graham

Triage Stage: AcceptedReady for checkin

comment:5 Changed 6 years ago by Gabriel Hurley

Resolution: fixed
Status: assignedclosed

(In [14070]) Fixes #13538 -- Clarified query examples with more explicit import statements and model vs. instance differentiation. Thanks to yipengh87@… and kmtracey for the report, and timo for the patch.

comment:6 Changed 6 years ago by Gabriel Hurley

(In [14073]) [1.2.X] Fixed #13538 -- Clarified query examples with more explicit import statements and model vs. instance differentiation. Thanks to yipengh87 and kmtracey for the report, and timo for the patch.

Backport of [14070] from trunk.

comment:7 Changed 6 years ago by Simon Meers

Shouldn't we be avoiding encouraging the use of project names such as 'mysite' in imports? cf. #14255

comment:8 Changed 6 years ago by Gabriel Hurley

Summary: Clarificications for http://docs.djangoproject.com/en/dev/topics/db/queries/Clarifications for http://docs.djangoproject.com/en/dev/topics/db/queries/

Ha. True enough. Picked up the patch for this before I saw your commit on that one. I'll fix it momentarily.

comment:9 Changed 5 years ago by Jacob

milestone: 1.3

Milestone 1.3 deleted

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