Django

Code

Ticket #1834 (new)

Opened 3 years ago

Last modified 2 years ago

Admin templatetags should have docstrings for admin documentation

Reported by: ubernostrum Assigned to: nobody
Milestone: Component: Documentation
Version: Keywords:
Cc: Triage Stage: Accepted
Has patch: 0 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

The admin templatetags currently have very little in the way of docstrings, which means that they don't provide any useful information in the admin documentation view; these should be fleshed out.

Attachments

adminapplist.diff (0.6 kB) - added by ubernostrum on 05/10/06 13:24:07.
Documentation patch for admin_app_list tag
adminmedia.diff (387 bytes) - added by ubernostrum on 05/10/06 13:26:36.
Documentation patch for admin_media_prefix tag
include_admin_script_doc.diff (0.8 kB) - added by Matias Hermanrud Fjeld <mhf@hex.no> on 06/13/06 07:48:55.
documentation for the include_admin_script tag

Change History

05/10/06 13:24:07 changed by ubernostrum

  • attachment adminapplist.diff added.

Documentation patch for admin_app_list tag

05/10/06 13:26:36 changed by ubernostrum

  • attachment adminmedia.diff added.

Documentation patch for admin_media_prefix tag

05/16/06 15:28:51 changed by adrian

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

(In [2920]) Fixed #1834 -- Added docstrings to admin template tags. Thanks, ubernostrum

05/16/06 18:57:06 changed by ubernostrum

  • status changed from closed to reopened.
  • resolution deleted.

Adrian, I was actually planning to do docstrings for all of the tags, not just those two. Just haven't had a spare moment to get around to it.

06/13/06 07:48:55 changed by Matias Hermanrud Fjeld <mhf@hex.no>

  • attachment include_admin_script_doc.diff added.

documentation for the include_admin_script tag

06/13/06 07:50:21 changed by anonymous

  • summary changed from Admin templatetags should have docstrings for admin documentation to [patch] Admin templatetags should have docstrings for admin documentation.

06/19/06 07:35:41 changed by mtredinnick

(In [3147]) Refs #1834 -- Documented include_admin_script tag in admin interface. Thanks to Matias Hermanrud Fjeld.

06/19/06 07:36:31 changed by mtredinnick

  • summary changed from [patch] Admin templatetags should have docstrings for admin documentation to Admin templatetags should have docstrings for admin documentation.

All the current patches are now in svn, so removing the [patch] keyword until some new additions are made.

11/04/06 05:51:37 changed by ubernostrum

  • owner changed from jacob to ubernostrum.
  • status changed from reopened to new.

Claiming this so that, if it's still pending a little ways down the road, I'll remember to do it.

02/22/07 21:31:31 changed by SmileyChris

  • stage changed from Unreviewed to Accepted.

ubernostrum, I'm guessing there's still some work to do on this? *nudge*


Add/Change #1834 (Admin templatetags should have docstrings for admin documentation)




Change Properties
Action