Opened 18 years ago

Closed 18 years ago

Last modified 17 years ago

#1408 closed enhancement (fixed)

[patch] admin doc should have a module description

Reported by: django@… Owned by: Adrian Holovaty
Component: contrib.admin Version: magic-removal
Severity: normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

the admin docs show descriptions of the fields, but not what the model is all about.
patch introduces a description field in Meta that is shows in the model details admin doc page under the summary.
I'm not sure if Meta is the best place, but using the doc string seems not to be best to translate and Admin not the proper place.

I'm not very good at writing docs, so its up to document the models in django :)

Attachments (3)

django_admin_modules_description.diff (1.7 KB ) - added by django@… 18 years ago.
implement module description
django_admin_modules_description_doc.diff (428 bytes ) - added by django@… 18 years ago.
docs changes. not very pretty :)
django_admin_modules_description2.diff (1.1 KB ) - added by django@… 18 years ago.
patch that uses docstrings

Download all attachments as: .zip

Change History (9)

comment:1 by anonymous, 18 years ago

Type: defectenhancement

by django@…, 18 years ago

implement module description

by django@…, 18 years ago

docs changes. not very pretty :)

comment:2 by Jacob, 18 years ago

Resolution: wontfix
Status: newclosed

This is already possible by overriding the change form template in your own app (make a {{admin/app_label/change_form}} or {{admin/app_label/model_name/change_form}} template.

by django@…, 18 years ago

patch that uses docstrings

comment:3 by django@…, 18 years ago

Resolution: wontfix
Status: closedreopened

as in spoken in irc, patch that uses docstrings instead

comment:4 by Adrian Holovaty, 18 years ago

The latest patch looks good.

comment:5 by Jacob, 18 years ago

Resolution: fixed
Status: reopenedclosed

(In [2417]) Exposed model doc in admin docs views which fixes #1408. Thanks, poelzi

comment:6 by Adrian Holovaty, 17 years ago

milestone: Version 0.92

Milestone Version 0.92 deleted

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