#23974: Ambiguous description of save option of FileField.save() method
--------------------------------------+--------------------
     Reporter:  GreenAsJade           |      Owner:  nobody
         Type:  Cleanup/optimization  |     Status:  new
    Component:  Documentation         |    Version:  1.7
     Severity:  Normal                |   Keywords:
 Triage Stage:  Unreviewed            |  Has patch:  0
Easy pickings:  1                     |      UI/UX:  0
--------------------------------------+--------------------
 Here:

 
https://docs.djangoproject.com/en/dev/ref/models/fields/#django.db.models.FileField

 The FileField.save() method's save argument is described thusly:


 "The optional save argument controls whether or not the instance is saved
 after the file has been altered. Defaults to True."

 It's not clear what instance is being referred to here: is it the instance
 of FileField (which gramatically appears to be the case) or the instance
 of the model that has the FileField (which I think is the case, and makes
 more sense).

 Note that in other places on this page, the field itself is referred to as
 an instance.

 It would be better if this said

 "The optional save argument controls whether or not the model instance is
 saved after the file associated with this FileField has been altered.
 Defaults to True."

--
Ticket URL: <https://code.djangoproject.com/ticket/23974>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/054.21c83f5143b95d299ea55d162e8a5ef7%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to