#16000 closed Cleanup/optimization (fixed)
Add information about using natural keys to contenttype documentation
| Reported by: | Jim Dalton | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
| Pull Requests: | How to create a pull request | ||
Description ¶
It took me quite a long time before I finally stumbled upon the section about using natural keys for deserialization in the context of ContentType objects in test fixtures. I actually missed it entirely in the documentation and pieced it together after reading through the comments in #7052.
The problem in my mind is that natural keys aren't mentioned anywhere in the contrib.contenttype documentation. I took it upon myself to address this to hopefully save others from getting stuck like I did.
Attached is a documentation patch on the contrib.contenttype docs which briefly mentions natural keys and points the reader to more information in the serialization and dumpdata sections.
Change History (6)
by , 14 years ago
| Attachment: | natural_keys_in_contenttype_docs.diff added |
|---|
comment:1 by , 14 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:2 by , 14 years ago
| Triage Stage: | Accepted → Ready for checkin |
|---|---|
| UI/UX: | unset |
That looks great, thanks!
Note:
See TracTickets
for help on using tickets.
Sounds like a reasonable addition to the docs.