Opened 19 years ago

Closed 19 years ago

Last modified 18 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: no UI/UX: no
Pull Requests:How to create a pull request

Description

Magic-removal now displays the models docstrings in the admin documentation pages. Models in django should have a nice docstring suitable for endusers.

Change History (7)

by Antti Kaihola, 19 years ago

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 by Adrian Holovaty, 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 Antti Kaihola, 19 years ago

Attachment: sessions-doc.diff​ added

Added docstrings.

by Antti Kaihola, 19 years ago

Attachment: sessions-doc.2.diff​ added

Fixed middleware path to magic_removal style

comment:2 by Antti Kaihola, 19 years ago

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

comment:3 by Antti Kaihola, 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 Malcolm Tredinnick, 19 years ago

Resolution: → fixed
Status: new → closed

(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