diff doc/xmlrpc.txt @ 4929:57a482110a24

doc: Link XMLRPC `filter` doc to User Guide chapter about querying
author anatoly techtonik <techtonik@gmail.com>
date Mon, 29 Sep 2014 18:37:26 +0300
parents 08a5a47855cb
children f47c35727b3e
line wrap: on
line diff
--- a/doc/xmlrpc.txt	Sat Sep 06 21:53:46 2014 +0200
+++ b/doc/xmlrpc.txt	Mon Sep 29 18:37:26 2014 +0300
@@ -88,10 +88,10 @@
 
 filter  arguments: *classname, list or None, attributes*
         
-        list can be None (requires ``allow_none=True`` when
-        instantiating the ServerProxy) to indicate search for all values,
-        or a list of ids. The attributes are given as a dictionary of
-        name value pairs to search for.
+        ``list`` is a list of ids to filter. It can be set to None to run
+        filter over all values (requires ``allow_none=True`` when
+        instantiating the ServerProxy). The ``attributes`` are given as a 
+        dictionary of name value pairs to search for. See also :ref:`query-tracker`.
 ======= ====================================================================
 
 sample python client

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