#13538 closed (fixed)
Clarifications for http://docs.djangoproject.com/en/dev/topics/db/queries/
| Reported by: | 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: | no | UI/UX: | no |
Description (last modified by )
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)
Change History (11)
comment:1 by , 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: | Unreviewed → Accepted |
comment:2 by , 14 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
by , 14 years ago
| Attachment: | 13538.diff added |
|---|
comment:3 by , 14 years ago
| Has patch: | set |
|---|---|
| milestone: | → 1.3 |
Added patch with some clarifications and additional imports.
by , 14 years ago
| Attachment: | 13538.2.diff added |
|---|
updating existing patch to fix syntax highlighting
comment:4 by , 14 years ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
comment:5 by , 14 years ago
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
comment:6 by , 14 years ago
comment:7 by , 14 years ago
Shouldn't we be avoiding encouraging the use of project names such as 'mysite' in imports? cf. #14255
comment:8 by , 14 years ago
| 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.
Note:
See TracTickets
for help on using tickets.
(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
entryis assumed to be an instance of theEntryclass. The previous section on saving changes to an object makes that clear by noting whatb5is before using it in the example code, it would probably make sense to avoid confusion and note something similar beforeentryis 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.