Mercurial > p > roundup > code
comparison doc/design.txt @ 4048:7ad0918ee8bd
Clarify 'search_matches' docs.
| author | Stefan Seefeld <stefan@seefeld.name> |
|---|---|
| date | Tue, 17 Feb 2009 13:05:44 +0000 |
| parents | be9122d753c5 |
| children | f4a863d88a99 |
comparison
equal
deleted
inserted
replaced
| 4047:e70643990e9c | 4048:7ad0918ee8bd |
|---|---|
| 473 def filter(self, search_matches, filterspec, sort, group): | 473 def filter(self, search_matches, filterspec, sort, group): |
| 474 """Return a list of the ids of the active nodes in this class that | 474 """Return a list of the ids of the active nodes in this class that |
| 475 match the 'filter' spec, sorted by the group spec and then the | 475 match the 'filter' spec, sorted by the group spec and then the |
| 476 sort spec. | 476 sort spec. |
| 477 | 477 |
| 478 "search_matches" is a container type | |
| 479 | |
| 478 "filterspec" is {propname: value(s)} | 480 "filterspec" is {propname: value(s)} |
| 479 | 481 |
| 480 "sort" and "group" are [(dir, prop), ...] where dir is '+', '-' | 482 "sort" and "group" are [(dir, prop), ...] where dir is '+', '-' |
| 481 or None and prop is a prop name or None. Note that for | 483 or None and prop is a prop name or None. Note that for |
| 482 backward-compatibility reasons a single (dir, prop) tuple is | 484 backward-compatibility reasons a single (dir, prop) tuple is |
| 483 also allowed. | 485 also allowed. |
| 484 | |
| 485 "search_matches" is {nodeid: marker} | |
| 486 | 486 |
| 487 The filter must match all properties specificed. If the property | 487 The filter must match all properties specificed. If the property |
| 488 value to match is a list: | 488 value to match is a list: |
| 489 | 489 |
| 490 1. String properties must match all elements in the list, and | 490 1. String properties must match all elements in the list, and |