#1422 closed enhancement (fixed)
[patch] Little, easy improvement: model docstrings for admin documentation
| Reported by: | Antti Kaihola | 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
Magic-removal now displays the models docstrings in the admin documentation pages. Models in django should have a nice docstring suitable for endusers.
Attachments (3)
Change History (7)
by , 19 years ago
| Attachment: | auth-doc.diff added |
|---|
comment:1 by , 19 years ago
Good idea! Some of the docstrings in the patch are a bit long, but we should indeed add docstrings to the built-in models so they show up in the admin docs.
by , 19 years ago
| Attachment: | sessions-doc.2.diff added |
|---|
Fixed middleware path to magic_removal style
comment:2 by , 19 years ago
| Summary: | Little, easy improvement: model docstrings for admin documentation → [patch] Little, easy improvement: model docstrings for admin documentation |
|---|
comment:3 by , 19 years ago
Pointers to documentation about content types, log entries, sites and other models that come with Django are appreciated. I'd rather not write it from scratch since I don't know the system inside out.
comment:4 by , 19 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
Note:
See TracTickets
for help on using tickets.
Added docstrings. They intentionally start straight after quotes to avoid gap in admin documentation screens. Also added a couple of field help_texts and method docstrings.