Opened 17 years ago

Closed 17 years ago

#3857 closed (fixed)

Table quick reference for FileField docs

Reported by: Nathaniel Whiteinge Owned by: Jacob
Component: Documentation Version: dev
Severity: Keywords:
Cc: dev@… 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 FileField documentation could really benefit from an 'arguments' quick-reference table. Additionally, another description of how 'upload_to' relates to 'MEDIA_ROOT' could be helpful for Django newbies.

This patch adds both.

Attachments (1)

model-api.txt.patch​ (1021 bytes ) - added by Nathaniel Whiteinge 17 years ago.

Download all attachments as: .zip

Change History (4)

by Nathaniel Whiteinge, 17 years ago

Attachment: model-api.txt.patch​ added

comment:1 by Simon G. <dev@…>, 17 years ago

Cc: dev@… added
Triage Stage: Unreviewed → Design decision needed

I'm not entirely sure that a section with only one parameter needs a table, however I do like the clarification of the upload_to.

comment:2 by Malcolm Tredinnick, 17 years ago

Triage Stage: Design decision needed → Ready for checkin

Worth changing, since all the other fields with required arguments use tables, so it makes scanning the document easier.

Might need some editing prior to committing, but that's normal.

comment:3 by Malcolm Tredinnick, 17 years ago

Resolution: → fixed
Status: new → closed

(In [5066]) Fixed #3857 -- Used a table to describe the required arg for FileField. This
makes it consistent with other argument descriptions. Thanks, whiteinge.

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