Commit dbf85fec authored by Leo Pound Singer's avatar Leo Pound Singer Committed by Leo Pound Singer

Fix some warnings due to backslashes in docstrings

This fixes the following warning that appears when you run
`python setup.py test`:

```
=============================== warnings summary ===============================
ligo/gracedb/rest.py:1203
  /Users/lpsinger/src/gracedb-client/ligo/gracedb/rest.py:1203: DeprecationWarning: invalid escape sequence \
    """  # noqa: W605

ligo/gracedb/rest.py:1300
  /Users/lpsinger/src/gracedb-client/ligo/gracedb/rest.py:1300: DeprecationWarning: invalid escape sequence \
    """  # noqa: W605

ligo/gracedb/rest.py:2227
  /Users/lpsinger/src/gracedb-client/ligo/gracedb/rest.py:2227: DeprecationWarning: invalid escape sequence \
    """  # noqa: W605

-- Docs: https://docs.pytest.org/en/latest/warnings.html
================ 488 passed, 98 deselected, 3 warnings in 5.63s ================
```
parent 01c5bc20
......@@ -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.
......
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