Skip to content

Commit 01fd903

Browse files
committed
doc: more table call alignment; fix formatting
1 parent 8a3fe87 commit 01fd903

File tree

1 file changed

+37
-36
lines changed

1 file changed

+37
-36
lines changed

doc/xmlrpc.txt

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Rate Limiting Failed Logins
9494
See the `rest documentation
9595
<rest.html#rate-limiting-api-failed-logins>`_ for rate limiting failed
9696
logins on the API. There is no login rate limiting for the standalone
97-
roundup-xmlrpc-server. Login rate limiting is only for the `/xmlrpc``
97+
roundup-xmlrpc-server. Login rate limiting is only for the ``/xmlrpc``
9898
endpoint when the Roundup server is used.
9999

100100
The XML-RPC uses the same method as the REST API.
@@ -107,53 +107,54 @@ requires that the user provide a username and password in the HTTP
107107
authorization header in order to authenticate the request against the
108108
tracker.
109109

110-
======= ====================================================================
111-
Command Description
112-
======= ====================================================================
113-
schema
110+
.. table::
111+
:class: valign-top
114112

115-
Fetch tracker schema.
113+
======= ===================================================================
114+
Command Description
115+
======= ===================================================================
116+
schema Fetch tracker schema.
116117

117-
list arguments: *classname, [property_name]*
118+
list arguments: *classname, [property_name]*
118119

119-
List all elements of a given ``classname``. If ``property_name`` is
120-
specified, that is the property that will be displayed for each
121-
element. If ``property_name`` is not specified the default label
122-
property will be used.
120+
List all elements of a given ``classname``. If ``property_name``
121+
is specified, that is the property that will be displayed for each
122+
element. If ``property_name`` is not specified the default label
123+
property will be used.
123124

124-
display arguments: *designator, [property_1, ..., property_N]*
125+
display arguments: *designator, [property_1, ..., property_N]*
125126

126-
Display a single item in the tracker as specified by ``designator``
127-
(e.g. issue20 or user5). The default is to display all properties
128-
for the item. Alternatively, a list of properties to display can be
129-
specified.
127+
Display a single item in the tracker as specified by ``designator``
128+
(e.g. issue20 or user5). The default is to display all properties
129+
for the item. Alternatively, a list of properties to display can
130+
be specified.
130131

131-
create arguments: *classname, arg_1 ... arg_N*
132+
create arguments: *classname, arg_1 ... arg_N*
132133

133-
Create a new instance of ``classname`` with ``arg_1`` through
134-
``arg_N`` as the values of the new instance. The arguments are
135-
name=value pairs (e.g. ``status='3'``).
134+
Create a new instance of ``classname`` with ``arg_1`` through
135+
``arg_N`` as the values of the new instance. The arguments are
136+
name=value pairs (e.g. ``status='3'``).
136137

137-
set arguments: *designator, arg_1 ... arg_N*
138+
set arguments: *designator, arg_1 ... arg_N*
138139

139-
Set the values of an existing item in the tracker as specified by
140-
``designator``. The new values are specified in ``arg_1`` through
141-
``arg_N``. The arguments are name=value pairs (e.g. ``status='3'``).
140+
Set the values of an existing item in the tracker as specified by
141+
``designator``. The new values are specified in ``arg_1`` through
142+
``arg_N``. The arguments are name=value pairs (e.g. ``status='3'``).
142143

143-
lookup arguments: *classname, key_value*
144+
lookup arguments: *classname, key_value*
144145

145-
looks up the key_value for the given class. The class needs to
146-
have a key and the user needs search permission on the key
147-
attribute and id for the given classname.
146+
looks up the key_value for the given class. The class needs to
147+
have a key and the user needs search permission on the key
148+
attribute and id for the given classname.
148149

149-
filter arguments: *classname, list or None, attributes*
150-
151-
``list`` is a list of ids to filter. It can be set to None to run
152-
filter over all values (requires ``allow_none=True`` when
153-
instantiating the ServerProxy). The ``attributes`` are given as a
154-
dictionary of name value pairs to search for. See also
155-
:ref:`query-tracker`.
156-
======= ====================================================================
150+
filter arguments: *classname, list or None, attributes*
151+
152+
``list`` is a list of ids to filter. It can be set to None to
153+
run filter over all values (requires ``allow_none=True`` when
154+
instantiating the ServerProxy). The ``attributes`` are given
155+
as a dictionary of name value pairs to search for. See also
156+
:ref:`query-tracker`.
157+
======= ===================================================================
157158

158159
Sample Python Client
159160
====================

0 commit comments

Comments
 (0)