Django

Code

Ticket #3857 (closed: fixed)

Opened 2 years ago

Last modified 2 years ago

Table quick reference for FileField docs

Reported by: whiteinge Assigned to: jacob
Milestone: Component: Documentation
Version: SVN Keywords:
Cc: dev@simon.net.nz Triage Stage: Ready for checkin
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

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

model-api.txt.patch (1.0 kB) - added by whiteinge on 03/28/07 23:53:33.

Change History

03/28/07 23:53:33 changed by whiteinge

  • attachment model-api.txt.patch added.

03/29/07 01:33:23 changed by Simon G. <dev@simon.net.nz>

  • cc set to dev@simon.net.nz.
  • needs_better_patch changed.
  • stage changed from Unreviewed to Design decision needed.
  • needs_tests changed.
  • needs_docs changed.

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.

04/24/07 02:34:12 changed by mtredinnick

  • 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.

04/25/07 01:38:24 changed by mtredinnick

  • status changed from new to closed.
  • resolution set to fixed.

(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/Change #3857 (Table quick reference for FileField docs)




Change Properties
Action