Django

Code

Ticket #1408 (closed: fixed)

Opened 3 years ago

Last modified 2 years ago

[patch] admin doc should have a module description

Reported by: django@poelzi.org Assigned to: adrian
Milestone: Component: django.contrib.admin
Version: magic-removal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

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

django_admin_modules_description.diff (1.7 kB) - added by django@poelzi.org on 02/27/06 09:47:13.
implement module description
django_admin_modules_description_doc.diff (428 bytes) - added by django@poelzi.org on 02/27/06 11:47:33.
docs changes. not very pretty :)
django_admin_modules_description2.diff (1.1 kB) - added by django@poelzi.org on 02/27/06 14:24:57.
patch that uses docstrings

Change History

02/27/06 09:46:24 changed by anonymous

  • type changed from defect to enhancement.

02/27/06 09:47:13 changed by django@poelzi.org

  • attachment django_admin_modules_description.diff added.

implement module description

02/27/06 11:47:33 changed by django@poelzi.org

  • attachment django_admin_modules_description_doc.diff added.

docs changes. not very pretty :)

02/27/06 12:36:36 changed by jacob

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

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.

02/27/06 14:24:57 changed by django@poelzi.org

  • attachment django_admin_modules_description2.diff added.

patch that uses docstrings

02/27/06 14:26:14 changed by django@poelzi.org

  • status changed from closed to reopened.
  • resolution deleted.

as in spoken in irc, patch that uses docstrings instead

02/27/06 14:55:16 changed by adrian

The latest patch looks good.

02/27/06 15:05:54 changed by jacob

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

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

10/24/06 15:17:23 changed by adrian

  • milestone deleted.

Milestone Version 0.92 deleted

Add/Change #1408 ([patch] admin doc should have a module description)




Change Properties
Action