Opened 19 years ago

Closed 15 years ago

Last modified 13 years ago

#1834 closed enhancement (fixed)

Admin templatetags should have docstrings for admin documentation

Reported by: James Bennett Owned by: Joshua Russo
Component: Documentation Version: dev
Severity: normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

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 James Bennett 19 years ago.
Documentation patch for admin_app_list tag
adminmedia.diff​ (387 bytes ) - added by James Bennett 19 years ago.
Documentation patch for admin_media_prefix tag
include_admin_script_doc.diff​ (830 bytes ) - added by Matias Hermanrud Fjeld <mhf@…> 18 years ago.
documentation for the include_admin_script tag
admin_templatetags_docstrings.diff​ (2.9 KB ) - added by Joshua Russo 15 years ago.
docstrings for admin templatetags and some internal functions
1834-1.1.X.diff​ (2.8 KB ) - added by Ramiro Morales 15 years ago.
Rupe's patch ported to 1.1.X branch

Download all attachments as: .zip

Change History (16)

by James Bennett, 19 years ago

Attachment: adminapplist.diff​ added

Documentation patch for admin_app_list tag

by James Bennett, 19 years ago

Attachment: adminmedia.diff​ added

Documentation patch for admin_media_prefix tag

comment:1 by Adrian Holovaty, 19 years ago

Resolution: → fixed
Status: new → closed

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

comment:2 by James Bennett, 19 years ago

Resolution: fixed
Status: closed → 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.

by Matias Hermanrud Fjeld <mhf@…>, 18 years ago

Attachment: include_admin_script_doc.diff​ added

documentation for the include_admin_script tag

comment:3 by anonymous, 18 years ago

Summary: Admin templatetags should have docstrings for admin documentation → [patch] Admin templatetags should have docstrings for admin documentation

comment:4 by Malcolm Tredinnick, 18 years ago

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

comment:5 by Malcolm Tredinnick, 18 years ago

Summary: [patch] Admin templatetags should have docstrings for admin documentation → 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 by James Bennett, 18 years ago

Owner: changed from Jacob to James Bennett
Status: reopened → new

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

comment:7 by Chris Beaven, 18 years ago

Triage Stage: Unreviewed → Accepted

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

by Joshua Russo, 15 years ago

Attachment: admin_templatetags_docstrings.diff​ added

docstrings for admin templatetags and some internal functions

comment:8 by Joshua Russo, 15 years ago

Has patch: set
milestone: → 1.2
Owner: changed from nobody to Joshua Russo
Status: new → assigned
Version: → SVN

This should be good to go

by Ramiro Morales, 15 years ago

Attachment: 1834-1.1.X.diff​ added

Rupe's patch ported to 1.1.X branch

comment:9 by Ramiro Morales, 15 years ago

Triage Stage: Accepted → Ready for checkin

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

comment:10 by Brian Rosner, 15 years ago

Resolution: → fixed
Status: assigned → closed

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

Thanks Rupe for work on a patch.

comment:11 by Jacob, 13 years ago

milestone: 1.2

Milestone 1.2 deleted

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