diff options
| author | Tim Graham <timograham@gmail.com> | 2014-12-08 13:15:46 -0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2014-12-08 13:18:32 -0500 |
| commit | 5fb7086b6b4c0129c57ea5928fd91d272f3e5858 (patch) | |
| tree | fac720c0e058c43f3e4f19d20f127c6818c38e0d /docs/ref/models | |
| parent | 30a12d6ca66ae2558740ef05f4a0b44566cfefa3 (diff) | |
[1.6.x] Fixed #23974 -- Clarified wording of FileField.save/delete save parameter.
Thanks GreenAsJade.
Backport of 1aa41dd000e0779c8b1de1f8e7aa4a0f2f752655 from master
Diffstat (limited to 'docs/ref/models')
| -rw-r--r-- | docs/ref/models/fields.txt | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index 84c88b000b..5c11412e33 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -690,8 +690,9 @@ method is used to persist that file data. Takes two required arguments: ``name`` which is the name of the file, and ``content`` which is an object containing the file's contents. The -optional ``save`` argument controls whether or not the instance is -saved after the file has been altered. Defaults to ``True``. +optional ``save`` argument controls whether or not the model instance is +saved after the file associated with this field has been altered. Defaults to +``True``. Note that the ``content`` argument should be an instance of :class:`django.core.files.File`, not Python's built-in file object. @@ -716,8 +717,9 @@ Deletes the file associated with this instance and clears all attributes on the field. Note: This method will close the file if it happens to be open when ``delete()`` is called. -The optional ``save`` argument controls whether or not the instance is saved -after the file has been deleted. Defaults to ``True``. +The optional ``save`` argument controls whether or not the model instance is +saved after the file associated with this field has been deleted. Defaults to +``True``. Note that when a model is deleted, related files are not deleted. If you need to cleanup orphaned files, you'll need to handle it yourself (for instance, |
