Opened 9 years ago

Closed 5 years ago

Last modified 4 years ago

#1834 closed enhancement (fixed)

Admin templatetags should have docstrings for admin documentation

Reported by: ubernostrum Owned by: Rupe
Component: Documentation Version: master
Severity: normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

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 (5)

adminapplist.diff (633 bytes) - added by ubernostrum 9 years ago.
Documentation patch for admin_app_list tag
adminmedia.diff (387 bytes) - added by ubernostrum 9 years ago.
Documentation patch for admin_media_prefix tag
include_admin_script_doc.diff (830 bytes) - added by Matias Hermanrud Fjeld <mhf@…> 9 years ago.
documentation for the include_admin_script tag
admin_templatetags_docstrings.diff (2.9 KB) - added by Rupe 5 years ago.
docstrings for admin templatetags and some internal functions
1834-1.1.X.diff (2.8 KB) - added by ramiro 5 years ago.
Rupe's patch ported to 1.1.X branch

Download all attachments as: .zip

Change History (16)

Changed 9 years ago by ubernostrum

Documentation patch for admin_app_list tag

Changed 9 years ago by ubernostrum

Documentation patch for admin_media_prefix tag

comment:1 Changed 9 years ago by adrian

  • Resolution set to fixed
  • Status changed from new to closed

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

comment:2 Changed 9 years ago by ubernostrum

  • Resolution fixed deleted
  • Status changed from closed to reopened

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.

Changed 9 years ago by Matias Hermanrud Fjeld <mhf@…>

documentation for the include_admin_script tag

comment:3 Changed 9 years ago by anonymous

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

comment:4 Changed 9 years ago by mtredinnick

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

comment:5 Changed 9 years ago 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.

comment:6 Changed 9 years ago 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.

comment:7 Changed 9 years ago by SmileyChris

  • Triage Stage changed from Unreviewed to Accepted

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

Changed 5 years ago by Rupe

docstrings for admin templatetags and some internal functions

comment:8 Changed 5 years ago by Rupe

  • Has patch set
  • milestone set to 1.2
  • Owner changed from nobody to Rupe
  • Status changed from new to assigned
  • Version set to SVN

This should be good to go

Changed 5 years ago by ramiro

Rupe's patch ported to 1.1.X branch

comment:9 Changed 5 years ago by ramiro

  • Triage Stage changed from Accepted to Ready for checkin

Last two patched attached to this ticket should be RFC (trunk and 1.1.X).

comment:10 Changed 5 years ago by brosner

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [13139]) Fixed #1834 -- added docstrings to admin templatetags

Thanks Rupe for work on a patch.

comment:11 Changed 4 years ago by jacob

  • milestone 1.2 deleted

Milestone 1.2 deleted

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