diff --git a/ligo/gracedb/rest.py b/ligo/gracedb/rest.py index 8cadd637886da7d2afb1a521c5f4cf69fabd233e..71160f24ae47e3965c432c37877172f4eae1f5dc 100644 --- a/ligo/gracedb/rest.py +++ b/ligo/gracedb/rest.py @@ -1124,7 +1124,7 @@ class GraceDb(GsiRest): def createSuperevent(self, t_start, t_0, t_end, preferred_event, category='production', events=None, labels=None): - """Create a superevent. + r"""Create a superevent. All LIGO-Virgo users can create test superevents, but special permissions are required to create production and MDC superevents. @@ -1225,7 +1225,7 @@ class GraceDb(GsiRest): def updateSuperevent(self, superevent_id, t_start=None, t_0=None, t_end=None, preferred_event=None, em_type=None, coinc_far=None): - """Update a superevent's parameters. + r"""Update a superevent's parameters. The same permission restrictions apply as for :py:meth:`ligo.gracedb.rest.GraceDb.createSuperevent`. You must provide @@ -2147,7 +2147,7 @@ class GraceDb(GsiRest): hardware_inj=False, CoincComment=False, ProbHasNS=None, ProbHasRemnant=None, BNS=None, NSBH=None, BBH=None, Terrestrial=None, MassGap=None, *args, **kwargs): - """Create a new VOEvent. + r"""Create a new VOEvent. Args: object_id (str): event graceid or superevent ID.