Fixed #23974 -- Clarified wording of FileField.save/delete save parameter.

Thanks GreenAsJade.
This commit is contained in:
Tim Graham 2014-12-08 13:15:46 -05:00
parent 4d27d72d14
commit 1aa41dd000
1 changed files with 6 additions and 4 deletions

View File

@ -715,8 +715,9 @@ method is used to persist that file data.
Takes two required arguments: ``name`` which is the name of the file, and Takes two required arguments: ``name`` which is the name of the file, and
``content`` which is an object containing the file's contents. The ``content`` which is an object containing the file's contents. The
optional ``save`` argument controls whether or not the instance is optional ``save`` argument controls whether or not the model instance is
saved after the file has been altered. Defaults to ``True``. saved after the file associated with this field has been altered. Defaults to
``True``.
Note that the ``content`` argument should be an instance of Note that the ``content`` argument should be an instance of
:class:`django.core.files.File`, not Python's built-in file object. :class:`django.core.files.File`, not Python's built-in file object.
@ -741,8 +742,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 the field. Note: This method will close the file if it happens to be open when
``delete()`` is called. ``delete()`` is called.
The optional ``save`` argument controls whether or not the instance is saved The optional ``save`` argument controls whether or not the model instance is
after the file has been deleted. Defaults to ``True``. 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 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, to cleanup orphaned files, you'll need to handle it yourself (for instance,