Opened 14 years ago

Last modified 13 years ago

#13538 closed

Clarificications for http://docs.djangoproject.com/en/dev/topics/db/queries/ — at Version 1

Reported by: yipengh87@… Owned by: nobody
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: no UI/UX: no

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 *

Change History (1)

comment:1 by Karen Tracey, 14 years ago

Description: modified (diff)
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.

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