Discrepenacy between documentation and docstring for Storage.save method

[Sergei Zh]

Docstring for django.core.files.storage.Storage.save method says:

        """
        Saves new content to the file specified by name. The content should be
        a proper File object or any python file-like object, ready to be read
        from the beginning.
        """

But in ​docs provided next description for content attribute

The content argument must be an instance of django.core.files.File or of a subclass of File.

What about to update docs or add additional check in save method?

[Baptiste Mispelon]

Hi,

I agree with you, there is a discrepancy here between the docstring and the documentation and we should correct that.

I have a feeling that the docstring might be the one that needs fixing but I am not sure. This will have to be determined.

Thanks.

[Tim Graham]

Looks like 664855b74e1f417384dc7aef35a3df5f86db52d6 added the option to use a file-like object but the docs weren't updated. Does this look like enough?

docs/ref/files/storage.txt

@@ -221 +221 @@
         :meth:`get_available_name`.
 
         The ``content`` argument must be an instance of
-        :class:`django.core.files.File` or of a subclass of
-        :class:`~django.core.files.File`.
+        :class:`django.core.files.File` or a file-like object.
 
     .. method:: size(name)

Alternatively, maybe "or a file-like object that can be wrapped in File".

[Baptiste Mispelon]

The proposed patch seems good to me.

Thanks.

[Tim Graham <timograham@…>]

In 3f16e4df:

Fixed #27145 -- Updated Storage.save() docs for refs #18899.

[Tim Graham <timograham@…>]

In f79dce16:

[1.10.x] Fixed #27145 -- Updated Storage.save() docs for refs #18899.

Backport of 3f16e4df494dc9143d110b886c8e8608f9d2b584 from master