Commit 84ef4a9b authored by James Bennett's avatar James Bennett
Browse files

Fixed #8641: Documented the fact that file-saving methods must receive a File instance

git-svn-id: http://code.djangoproject.com/svn/django/trunk@8759 bcc190cf-cafb-0310-a4f2-bffc1f526a37
parent ce24a1f8
Loading
Loading
Loading
Loading
+3 −0
Original line number Diff line number Diff line
@@ -110,6 +110,9 @@ are the same as this one line::

    >>> car.photo.save('myphoto.jpg', contents, save=True)

Note that the ``content`` argument must be an instance of
:class:`File` or of a subclass of :class:`File`.

``File.delete(save=True)``
~~~~~~~~~~~~~~~~~~~~~~~~~~

+4 −0
Original line number Diff line number Diff line
@@ -42,6 +42,10 @@ If there already exists a file with this name ``name``, the storage system may
modify the filename as necessary to get a unique name. The actual name of the
stored file will be returned.

The ``content`` argument must be an instance of
:class:`django.db.files.File` or of a subclass of
:class:`~django.db.files.File`.

``Storage.delete(name)``
~~~~~~~~~~~~~~~~~~~~~~~~

+2 −1
Original line number Diff line number Diff line
@@ -96,8 +96,9 @@ You can create an instance of some custom file storage class, or -- often more
useful -- you can use the global default storage system::

    >>> from django.core.files.storage import default_storage
    >>> from django.core.files.base import ContentFile

    >>> path = default_storage.save('/path/to/file', 'new content')
    >>> path = default_storage.save('/path/to/file', ContentFile('new content'))
    >>> path
    u'/path/to/file'