Fix some docstring errors

parent 2554f944
...@@ -642,7 +642,7 @@ class GraceDb(GsiRest): ...@@ -642,7 +642,7 @@ class GraceDb(GsiRest):
url (:obj:`str`, optional): URL of server API root. url (:obj:`str`, optional): URL of server API root.
proxy_host (:obj:`str`, optional): proxy hostname. proxy_host (:obj:`str`, optional): proxy hostname.
proxy_port (:obj:`str`, optional): proxy port. proxy_port (:obj:`str`, optional): proxy port.
cred (:obj:`str`, optional): a tuple or list of cred (:obj:`tuple` or :obj:`str`, optional): a tuple or list of
(``/path/to/cert/file``, ``/path/to/key/file``) or a single path to (``/path/to/cert/file``, ``/path/to/key/file``) or a single path to
a combined proxy file. Used for X.509 authentication only. a combined proxy file. Used for X.509 authentication only.
username (:obj:`str`, optional): username for basic auth. username (:obj:`str`, optional): username for basic auth.
...@@ -1210,10 +1210,10 @@ class GraceDb(GsiRest): ...@@ -1210,10 +1210,10 @@ class GraceDb(GsiRest):
Args: Args:
superevent_id (str): GraceDB ID of superevent to update superevent_id (str): GraceDB ID of superevent to update
t_start (:obj:`str`, optional): new t\ :sub:`start` value for t_start (:obj:`float`, optional): new t\ :sub:`start` value for
superevent superevent
t_0 (:obj:`str`, optional): new t\ :sub:`0` value for superevent t_0 (:obj:`float`, optional): new t\ :sub:`0` value for superevent
t_end (:obj:`str`, optional): new t\ :sub:`end` value for t_end (:obj:`float`, optional): new t\ :sub:`end` value for
superevent superevent
preferred_event (:obj:`str`, optional): graceid corresponding to preferred_event (:obj:`str`, optional): graceid corresponding to
an event which will be set as the new preferred event for this an event which will be set as the new preferred event for this
...@@ -2545,7 +2545,8 @@ class GraceDb(GsiRest): ...@@ -2545,7 +2545,8 @@ class GraceDb(GsiRest):
``'operator'`` (operator signoff), or ``'ADV'`` or ``'operator'`` (operator signoff), or ``'ADV'`` or
``'advocate'`` (advocate signoff). ``'advocate'`` (advocate signoff).
status (:obj:`str`, optional): signoff status (if changed). status (:obj:`str`, optional): signoff status (if changed).
comment (:obj:`str`): comment on the signoff (if changed). comment (:obj:`str`, optional): comment on the signoff
(if changed).
instrument (:obj:`str`, optional): instrument abbreviation instrument (:obj:`str`, optional): instrument abbreviation
(``'H1'``, ``'L1'``, etc.) for operator signoffs. Leave blank (``'H1'``, ``'L1'``, etc.) for operator signoffs. Leave blank
for advocate signoffs. for advocate signoffs.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment