Opened 10 years ago

Closed 10 years ago

#3857 closed (fixed)

Table quick reference for FileField docs

Reported by: Nathaniel Whiteinge Owned by: Jacob
Component: Documentation Version: master
Severity: Keywords:
Cc: dev@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

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 10 years ago.

Download all attachments as: .zip

Change History (4)

Changed 10 years ago by Nathaniel Whiteinge

Attachment: model-api.txt.patch added

comment:1 Changed 10 years ago by Simon G. <dev@…>

Cc: dev@… added
Triage Stage: UnreviewedDesign 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 Changed 10 years ago by Malcolm Tredinnick

Triage Stage: Design decision neededReady 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 Changed 10 years ago by Malcolm Tredinnick

Resolution: fixed
Status: newclosed

(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