diff doc/customizing.txt @ 2859:a204a49e0974 maint-0.7

merge from HEAd
author Richard Jones <richard@users.sourceforge.net>
date Wed, 03 Nov 2004 03:07:51 +0000
parents 53c0c18b59c6
children f203541b1116
line wrap: on
line diff
--- a/doc/customizing.txt	Wed Nov 03 02:57:37 2004 +0000
+++ b/doc/customizing.txt	Wed Nov 03 03:07:51 2004 +0000
@@ -1620,8 +1620,18 @@
 list        lists all of the active (not retired) items in the class.
 csv         return the items of this class as a chunk of CSV text.
 propnames   lists the names of the properties of this class.
-filter      lists of items from this class, filtered and sorted by the
-            current *request* filterspec/filter/sort/group args
+filter      lists of items from this class, filtered and sorted. Two
+            options are avaible for sorting:
+
+            1. by the current *request* filterspec/filter/sort/group args
+            2. by the "filterspec", "sort" and "group" keyword args.
+               "filterspec" is ``{propname: value(s)}``. "sort" and
+               "group" are ``(dir, prop)`` where dir is '+', '-' or None
+               and prop is a prop name or None.
+
+            eg. ``issue.filter(filterspec={"priority": "1"},
+            sort=('activity', '+'))``
+
 classhelp   display a link to a javascript popup containing this class'
             "help" template.
 submit      generate a submit button (and action hidden element)

Roundup Issue Tracker: http://roundup-tracker.org/