#1408 closed enhancement (fixed)
[patch] admin doc should have a module description
| Reported by: | 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)
Change History (9)
comment:1 by , 20 years ago
| Type: | defect → enhancement |
|---|
by , 20 years ago
| Attachment: | django_admin_modules_description.diff added |
|---|
by , 20 years ago
| Attachment: | django_admin_modules_description_doc.diff added |
|---|
docs changes. not very pretty :)
comment:2 by , 20 years ago
| Resolution: | → wontfix |
|---|---|
| Status: | new → 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.
by , 20 years ago
| Attachment: | django_admin_modules_description2.diff added |
|---|
patch that uses docstrings
comment:3 by , 20 years ago
| Resolution: | wontfix |
|---|---|
| Status: | closed → reopened |
as in spoken in irc, patch that uses docstrings instead
comment:5 by , 20 years ago
| Resolution: | → fixed |
|---|---|
| Status: | reopened → closed |
Note:
See TracTickets
for help on using tickets.
implement module description