Code

Opened 8 years ago

Closed 8 years ago

Last modified 7 years ago

#1408 closed enhancement (fixed)

[patch] admin doc should have a module description

Reported by: django@… Owned by: adrian
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: UI/UX:

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@… 8 years ago.
implement module description
django_admin_modules_description_doc.diff (428 bytes) - added by django@… 8 years ago.
docs changes. not very pretty :)
django_admin_modules_description2.diff (1.1 KB) - added by django@… 8 years ago.
patch that uses docstrings

Download all attachments as: .zip

Change History (9)

comment:1 Changed 8 years ago by anonymous

  • Type changed from defect to enhancement

Changed 8 years ago by django@…

implement module description

Changed 8 years ago by django@…

docs changes. not very pretty :)

comment:2 Changed 8 years ago by jacob

  • Resolution set to wontfix
  • Status changed from new to closed

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.

Changed 8 years ago by django@…

patch that uses docstrings

comment:3 Changed 8 years ago by django@…

  • Resolution wontfix deleted
  • Status changed from closed to reopened

as in spoken in irc, patch that uses docstrings instead

comment:4 Changed 8 years ago by adrian

The latest patch looks good.

comment:5 Changed 8 years ago by jacob

  • Resolution set to fixed
  • Status changed from reopened to closed

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

comment:6 Changed 7 years ago by adrian

  • milestone Version 0.92 deleted

Milestone Version 0.92 deleted

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.