Code

Ticket #8419: doc-improvement.diff

File doc-improvement.diff, 995 bytes (added by Richard Davies <richard.davies@…>, 6 years ago)

Minor improvement to documentation of force_insert and force_update for save()

Line 
1Index: docs/ref/models/instances.txt
2===================================================================
3--- docs/ref/models/instances.txt       (revision 8649)
4+++ docs/ref/models/instances.txt       (working copy)
5@@ -205,10 +205,11 @@
6 the ``save()`` method. Passing both parameters is an error, since you cannot
7 both insert *and* update at the same time.
8 
9-It should be very rare that you'll need to use these parameters. Django will
10-almost always do the right thing and trying to override that will lead to
11-errors that are difficult to track down. This feature is for advanced use
12-only.
13+It should be very rare that you'll need to use these parameters - typically
14+only when your model does not have an ``AutoField`` primary key or when you
15+have explicitly specified the auto-primary-key value. Django will almost
16+always do the right thing and trying to override that will lead to errors
17+that are difficult to track down. This feature is for advanced use only.
18 
19 .. _model-instance-methods:
20