Opened 9 years ago

Closed 9 years ago

Last modified 8 years ago

#1422 closed enhancement (fixed)

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

Reported by: akaihola Owned by: adrian
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 akaihola 9 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 akaihola 9 years ago.
Added docstrings.
sessions-doc.2.diff (1.7 KB) - added by akaihola 9 years ago.
Fixed middleware path to magic_removal style

Download all attachments as: .zip

Change History (7)

Changed 9 years ago by akaihola

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 9 years ago by adrian

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 9 years ago by akaihola

Added docstrings.

Changed 9 years ago by akaihola

Fixed middleware path to magic_removal style

comment:2 Changed 9 years ago by akaihola

  • Summary changed from Little, easy improvement: model docstrings for admin documentation to [patch] Little, easy improvement: model docstrings for admin documentation

comment:3 Changed 9 years ago by akaihola

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 9 years ago by mtredinnick

  • Resolution set to fixed
  • Status changed from new to 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