Code

Opened 7 years ago

Closed 7 years ago

#3857 closed (fixed)

Table quick reference for FileField docs

Reported by: 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 whiteinge 7 years ago.

Download all attachments as: .zip

Change History (4)

Changed 7 years ago by whiteinge

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

  • Cc dev@… added
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to 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 Changed 7 years ago by mtredinnick

  • Triage Stage changed from Design decision needed to 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 Changed 7 years ago by mtredinnick

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

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.