Opened 11 years ago

Closed 10 years ago

Last modified 10 years ago

#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: UI/UX:

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)

auth-doc.diff (6.3 KB) - added by Antti Kaihola 11 years ago.
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.
sessions-doc.diff (1.7 KB) - added by Antti Kaihola 11 years ago.
Added docstrings.
sessions-doc.2.diff (1.7 KB) - added by Antti Kaihola 11 years ago.
Fixed middleware path to magic_removal style

Download all attachments as: .zip

Change History (7)

Changed 11 years ago by Antti Kaihola

Attachment: auth-doc.diff added

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.

comment:1 Changed 11 years ago by Adrian Holovaty

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.

Changed 11 years ago by Antti Kaihola

Attachment: sessions-doc.diff added

Added docstrings.

Changed 11 years ago by Antti Kaihola

Attachment: sessions-doc.2.diff added

Fixed middleware path to magic_removal style

comment:2 Changed 11 years ago by Antti Kaihola

Summary: Little, easy improvement: model docstrings for admin documentation[patch] Little, easy improvement: model docstrings for admin documentation

comment:3 Changed 11 years ago by Antti Kaihola

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 Changed 10 years ago by Malcolm Tredinnick

Resolution: fixed
Status: newclosed

(In [3167]) Fixed #1422 -- Docstring improvements for the models in the admin app. Thanks
akaihola.

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