Opened 6 years ago

Closed 6 years ago

#10862 closed (fixed)

Confusing image field text

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

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 timo 6 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 Changed 6 years ago by SmileyChris

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement set
  • Triage Stage changed from Unreviewed to Accepted
  • Version changed from 1.0 to SVN

Changed 6 years ago by timo

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

comment:2 Changed 6 years ago by timo

  • Has patch set
  • Patch needs improvement unset
  • Triage Stage changed from Accepted to Ready for checkin

comment:3 Changed 6 years ago by adrian

  • Resolution set to fixed
  • Status changed from new to 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