Opened 7 years ago

Closed 7 years ago

Last modified 5 years ago

#11056 closed (fixed)

wrong object listed as a dependency in storage doc

Reported by: wam Owned by: nobody
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

at http://docs.djangoproject.com/en/dev/ref/files/storage/#storage-save-name-content the following statement is made:

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

That URL corresponds to:
django/docs/ref/files/storage.txt which includes the following text:

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

In fact, there is no django.db.files.File object defined. I suspect the actual object that the documentation refers to is
django.core.files.File. I'll attach a patch against the doc that corrects this mistake.

Attachments (1)

django_docs_ref_files_storage_txt.patch (569 bytes) - added by wam 7 years ago.
patch to fix the buggy reference to non existant objects.

Download all attachments as: .zip

Change History (5)

Changed 7 years ago by wam

patch to fix the buggy reference to non existant objects.

comment:1 Changed 7 years ago by adamfast

milestone: 1.1
Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Triage Stage: UnreviewedReady for checkin

comment:2 Changed 7 years ago by Russell Keith-Magee

Resolution: fixed
Status: newclosed

(In [10970]) Fixed #11056 -- Corrected reference to File class in storage docs. Thanks to wam for the report.

comment:3 Changed 7 years ago by Russell Keith-Magee

(In [10977]) [1.0.X] Fixed #11056 -- Corrected reference to File class in storage docs. Thanks to wam for the report.

Merge of r10970 from trunk.

comment:4 Changed 5 years ago by Jacob

milestone: 1.1

Milestone 1.1 deleted

Note: See TracTickets for help on using tickets.
Back to Top