diff -r 78a99960286a -r 64a400eea6dd ext/rest.py --- a/ext/rest.py Tue Dec 18 12:42:56 2012 +0100 +++ b/ext/rest.py Fri Mar 08 18:43:42 2013 +0100 @@ -96,7 +96,16 @@ **options)], [] def rql_role(role, rawtext, text, lineno, inliner, options={}, content=[]): - """:rql:`Any X,Y WHERE X is CWUser, X login Y:table`""" + """:rql:`` or :rql:`:` + + Example: :rql:`Any X,Y WHERE X is CWUser, X login Y:table` + + Replace the directive with the output of applying the view to the resultset + returned by the query. + + "X eid %(userid)s" can be used in the RQL query for this query will be + executed with the argument {'userid': _cw.user.eid}. + """ _cw = inliner.document.settings.context._cw text = text.strip() if ':' in text: