updating function docstrings with correct signatures since they are obscured...

updating function docstrings with correct signatures since they are obscured by the decorator, even with functools.wraps
parent 7b02ee20
......@@ -716,6 +716,10 @@ class GraceDb(GsiRest):
"""
Create a superevent.
Signature:
createSuperevent(t_start, t_0, t_end, preferred_event,
events=[], labels=None)
Arguments:
t_start: t_start of superevent
t_0: t_0 of superevent
......@@ -780,6 +784,10 @@ class GraceDb(GsiRest):
"""
Update a superevent's parameters.
Signature:
updateSuperevent(superevent_id, t_start=None, t_0=None,
t_end=None, preferred_event=None)
Arguments:
superevent_id: id of superevent to update
t_start: t_start of superevent
......@@ -819,6 +827,9 @@ class GraceDb(GsiRest):
so the server will throw an error if the event is part of another
superevent already.
Signature:
addEventToSuperevent(superevent_id, graceid)
Arguments:
superevent_id: id of superevent to which the event will be added
graceid: graceid of event to add to superevent
......@@ -839,6 +850,9 @@ class GraceDb(GsiRest):
"""
Remove an event from a superevent.
Signature:
removeEventFromSuperevent(superevent_id, graceid)
Arguments:
superevent_id, graceid
......@@ -857,6 +871,9 @@ class GraceDb(GsiRest):
"""
Get information about a specific superevent.
Signature:
superevent(superevent_id)
Arguments:
superevent_id
......@@ -872,6 +889,9 @@ class GraceDb(GsiRest):
"""
Get an iterator of superevents in response to a query.
Signature:
superevents(query='', orderby=[], count=None, columns=[])
Arguments:
query: query string for filtering superevents (same as on the
web interface)
......@@ -943,6 +963,9 @@ class GraceDb(GsiRest):
"""
Files for a particular event or superevent.
Signature:
files(object_id, filename="")
Arguments:
object_id: event graceid or superevent id
filename: name of file (optional)
......@@ -987,6 +1010,9 @@ class GraceDb(GsiRest):
"""
Upload a file for an event or superevent.
Signature:
writeFile(object_id, filename, filecontents=None)
Required args:
object_id: event graceid or superevent id
filename: path to file
......@@ -1012,6 +1038,9 @@ class GraceDb(GsiRest):
"""
Get log messages associated with an event or superevent
Signature:
logs(object_id, log_number=None)
Arguments:
object_id: event graceid or superevent id
log_number: log message number (N) of log message to retrieve
......@@ -1063,7 +1092,11 @@ class GraceDb(GsiRest):
def writeLog(self, object_id, message, filename=None, filecontents=None,
tag_name=[], displayName=[], *args, **kwargs):
"""
Create a new log message
Create a new log message.
Signature:
writeLog(object_id, message, filename=None, filecontents=None,
tag_name=[], displayName=[])
Arguments:
object_id: event graceid or superevent id
......@@ -1221,6 +1254,9 @@ class GraceDb(GsiRest):
Given an event graceid or superevent id, get a list of EM observation
entries or a specific EM observation.
Signature:
emobservations(object_id, emobservation_num=None)
Arguments:
object_id: event graceid or superevent id
emobservation_num: number of the EM observation (N) (optional)
......@@ -1265,6 +1301,11 @@ class GraceDb(GsiRest):
"""
Write an EM observation entry.
Signature:
writeEMObservation(object_id, group, raList, raWidthList,
decList, decWidthList, startTimeList, durationList,
comment=None)
Required args: graceid, group, raList, decList, raWidthList,
decWidthList, startTimeList, durationList
......@@ -1315,6 +1356,9 @@ class GraceDb(GsiRest):
"""
Get a list of labels or a single label for an event or superevent.
Signature:
labels(object_id, label="")
Arguments:
object_id: event graceid or superevent id
label: name of label (optional)
......@@ -1358,12 +1402,15 @@ class GraceDb(GsiRest):
"""
Add a new label to an event or superevent.
Signature:
writeLabel(object_id, label)
Arguments:
object_id: event graceid or superevent id
label: label name
The label name must correspond to one of the existing
GraceDB labels, else an error will result.
GraceDB labels (see self.allowed_labels), or an error will result.
Example:
......@@ -1398,6 +1445,9 @@ class GraceDb(GsiRest):
"""
Remove a label from an event or superevent.
Signature:
removeLabel(object_id, label)
Arguments:
object_id: event graceid or superevent id
label: name of label to be removed
......@@ -1427,6 +1477,9 @@ class GraceDb(GsiRest):
Get a list of tags associated with a particular event or superevent
log message.
Signature:
tags(object_id, N)
Arguments:
object_id: event graceid or superevent id
N: log message number
......@@ -1461,6 +1514,9 @@ class GraceDb(GsiRest):
"""
Add a new tag to an event or superevent log message.
Signature:
addTag(object_id, N, tag_name, displayName=None)
Arguments:
object_id: event graceid or superevent id
N: log message number
......@@ -1504,6 +1560,9 @@ class GraceDb(GsiRest):
"""
Remove a tag from a given event or superevent log message.
Signature:
removeTag(object_id, N, tag_name)
Arguments:
object_id: event graceid or superevent id
N: log message number
......@@ -1550,6 +1609,9 @@ class GraceDb(GsiRest):
"""
Get a list of VOEvents or a single VOEvent for an event or superevent.
Signature:
voevents(object_id, voevent_num=None, get_voevent_file_text=True)
Arguments:
object_id: event graceid or superevent id
voevent_num: number of VOEvent to retrieve (optional)
......@@ -1629,6 +1691,9 @@ class GraceDb(GsiRest):
# TBD for superevents - requires a lot of changes to server code
"""Create a new VOEvent
Signature:
createVOEvent(graceid, voevent_type, *args, **kwargs)
Required args: graceid, voevent_type
Additional keyword arguments may be passed in to be sent in the POST
......
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