Django

Code

Ticket #1422 (closed: fixed)

Opened 3 years ago

Last modified 2 years ago

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

Reported by: akaihola Assigned to: adrian
Milestone: Component: django.contrib.admin
Version: magic-removal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

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

auth-doc.diff (6.3 kB) - added by akaihola on 02/28/06 10:26:31.
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 on 02/28/06 10:36:40.
Added docstrings.
sessions-doc.2.diff (1.7 kB) - added by akaihola on 02/28/06 10:39:55.
Fixed middleware path to magic_removal style

Change History

02/28/06 10:26:31 changed by akaihola

  • 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.

02/28/06 10:36:13 changed 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.

02/28/06 10:36:40 changed by akaihola

  • attachment sessions-doc.diff added.

Added docstrings.

02/28/06 10:39:55 changed by akaihola

  • attachment sessions-doc.2.diff added.

Fixed middleware path to magic_removal style

02/28/06 10:40:50 changed by akaihola

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

02/28/06 10:47:50 changed 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.

06/19/06 23:07:32 changed by mtredinnick

  • status changed from new to closed.
  • resolution set to fixed.

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

Add/Change #1422 ([patch] Little, easy improvement: model docstrings for admin documentation)




Change Properties
Action