Opened 5 years ago

Closed 4 years ago

Last modified 4 years ago

#16000 closed Cleanup/optimization (fixed)

Add information about using natural keys to contenttype documentation

Reported by: jsdalton Owned by: nobody
Component: Documentation Version: master
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


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.

Attachments (1)

natural_keys_in_contenttype_docs.diff (1.9 KB) - added by jsdalton 5 years ago.

Download all attachments as: .zip

Change History (6)

Changed 5 years ago by jsdalton

comment:1 Changed 5 years ago by d0ugal

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Sounds like a reasonable addition to the docs.

comment:2 Changed 4 years ago by julien

  • Triage Stage changed from Accepted to Ready for checkin
  • UI/UX unset

That looks great, thanks!

comment:3 Changed 4 years ago by DrMeers

  • Resolution set to fixed
  • Status changed from new to closed

In [16536]:

Fixed #16000 -- reference natural keys in contenttypes documentation. Thanks jsdalton.

comment:4 Changed 4 years ago by DrMeers

In [16537]:

[1.3.X] Fixed #16000 -- reference natural keys in contenttypes documentation. Thanks jsdalton.

Backport of r16536 from trunk.

comment:5 Changed 4 years ago by jacob

  • milestone 1.4 deleted

Milestone 1.4 deleted

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