Skip to content

Commit d1dfbe8

Browse files
author
Richard Jones
committed
fix filter() doc
1 parent 2cdee08 commit d1dfbe8

File tree

3 files changed

+18
-20
lines changed

3 files changed

+18
-20
lines changed

doc/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
STXTOHTML = rst2html
22
STXTOHT = rst2ht.py
3-
WEBDIR = ../../htdocs/htdocs/doc-0.7
3+
WEBDIR = ../../htdocs/htdocs/doc-0.8
44

55
SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \
66
glossary.txt implementation.txt index.txt design.txt mysql.txt \
77
installation.txt upgrading.txt user_guide.txt admin_guide.txt \
8-
postgresql.txt tracker_templates.txt whatsnew-0.7.txt
8+
postgresql.txt tracker_templates.txt whatsnew-0.8.txt
99

1010
COMPILED := $(SOURCE:.txt=.html)
1111
WEBHT := $(SOURCE:.txt=.ht)

doc/announcement.txt

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,12 @@
1-
I'm proud to release this 7th major feature release of Roundup.
1+
I'm proud to release this 8th major feature release of Roundup.
22

3-
Version 0.7 introduces far too many features to list here so I've put
3+
Version 0.8 introduces far too many features to list here so I've put
44
together a What's New page:
55

6-
http://roundup.sourceforge.net/doc-0.7/whatsnew-0.7.html
6+
http://roundup.sourceforge.net/doc-0.8/whatsnew-0.8.html
77

88
Some highlights:
99

10-
- added postgresql backend
11-
- trackers using postgresql or mysql backends may have many users
12-
- new "actor" automatic property (user who caused the last "activity")
13-
- RDBMS backends have data typed columns and indexes on several columns
14-
- registration may be concluded by replying to the confirmation email
15-
- HTML templating permission checks are greatly simplified
16-
- database exports now include full journals
17-
- IMAP support in the mail gateway
18-
19-
Known issues:
20-
21-
- the metakit import feature currently has a bug and should not be used
2210

2311
If you're upgrading from an older version of Roundup you *must* follow
2412
the "Software Upgrade" guidelines given in the maintenance documentation.

doc/customizing.txt

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Customising Roundup
33
===================
44

5-
:Version: $Revision: 1.148 $
5+
:Version: $Revision: 1.149 $
66

77
.. This document borrows from the ZopeBook section on ZPT. The original is at:
88
http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -1679,8 +1679,18 @@ properties return a `hyperdb property wrapper`_ for all of this class's
16791679
list lists all of the active (not retired) items in the class.
16801680
csv return the items of this class as a chunk of CSV text.
16811681
propnames lists the names of the properties of this class.
1682-
filter lists of items from this class, filtered and sorted by the
1683-
current *request* filterspec/filter/sort/group args
1682+
filter lists of items from this class, filtered and sorted. Two
1683+
options are avaible for sorting:
1684+
1685+
1. by the current *request* filterspec/filter/sort/group args
1686+
2. by the "filterspec", "sort" and "group" keyword args.
1687+
"filterspec" is ``{propname: value(s)}``. "sort" and
1688+
"group" are ``(dir, prop)`` where dir is '+', '-' or None
1689+
and prop is a prop name or None.
1690+
1691+
eg. ``issue.filter(filterspec={"priority": "1"},
1692+
sort=('activity', '+'))``
1693+
16841694
classhelp display a link to a javascript popup containing this class'
16851695
"help" template.
16861696
submit generate a submit button (and action hidden element)

0 commit comments

Comments
 (0)