Opened 17 years ago

Closed 17 years ago

#10862 closed (fixed)

Confusing image field text

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

Description

The page ​http://docs.djangoproject.com/en/dev/ref/models/fields/#imagefield has the documentation, "In addition to the special attributes that are available for FileField, an ImageField also has File.height and File.width attributes. See ​Managing files."

However, clicking Managing files takes you to ​http://docs.djangoproject.com/en/dev/topics/files/#topics-files which does not mention width or height on the page.

I can see how this would be confusing to people reading the docs. Would a link to ​http://docs.djangoproject.com/en/dev/ref/files/file/#additional-imagefield-attributes be clearer? Or perhaps mention the words width or height by the link, "The File Object" so users see that and follow through?

Attachments (1)

10862.diff​ (629 bytes ) - added by Tim Graham 17 years ago.
linked height/width attributes; removed seemingly out of place reference to managing files

Download all attachments as: .zip

Change History (4)

comment:1 by Chris Beaven, 17 years ago

Patch needs improvement: set
Triage Stage: Unreviewed → Accepted
Version: 1.0 → SVN

by Tim Graham, 17 years ago

Attachment: 10862.diff​ added

linked height/width attributes; removed seemingly out of place reference to managing files

comment:2 by Tim Graham, 17 years ago

Has patch: set
Patch needs improvement: unset
Triage Stage: Accepted → Ready for checkin

comment:3 by Adrian Holovaty, 17 years ago

Resolution: → fixed
Status: new → closed

(In [12162]) Fixed #10862 -- Clarified confusing documentation about ImageField height/width. Thanks, mw and timo

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