Opened 15 years ago

Closed 14 years ago

#13162 closed (fixed)

Little error in "the file object" documentation

Reported by: tyrion.mx@… Owned by: nobody
Component: Documentation Version: dev
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

In the File object documentation ( http://docs.djangoproject.com/en/dev/topics/files/#the-file-object ) it says I can access any attribute documented in the File object ( http://docs.djangoproject.com/en/dev/ref/files/file/#ref-files-file ). But for example the url attribute isn't always accessible. I think the doc should be corrected removing the sentence "Now you can use any of the File attributes and methods documented in The File object."

Change History (2)

comment:1 by Russell Keith-Magee, 15 years ago

Triage Stage: UnreviewedAccepted

Accepted, but I don't think it's quite the problem you describe. The issue seems to be that the documentation for the django.core.files.File object includes attributes that are only available on django.db.fields.files.FieldFile (in particular, url, path and size). There is definitely some cleaning up required here.

comment:2 by Gabriel Hurley, 14 years ago

Resolution: fixed
Status: newclosed

(In [14834]) [1.2.X] Fixed #13162 and #11597 -- Improved the file handling documentation: Removed documentation of methods on django.core.files.File that did not exist, added documentation for undocumented methods and attributes that did exist, did a general cleanup of the text and organization, and added more metadata targets. Thanks to amenasse and tyrion.mx for the reports.

Backport of [14833] from trunk.

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