Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace \* with \\* in docstrings #68

Merged
merged 1 commit into from
Jun 24, 2021
Merged

Replace \* with \\* in docstrings #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions pdpyras.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ def request(self, method, url, **kwargs):
:param url:
The path/URL to request. If it does not start with the base URL, the
base URL will be prepended.
:param \*\*kwargs:
:param \\*\\*kwargs:
Additional keyword arguments to pass to `requests.Session.request`_
:type method: str
:type url: str
Expand Down Expand Up @@ -691,7 +691,7 @@ def send_event(self, action, dedup_key=None, **properties):
:param dedup_key:
The deduplication key; used for determining event uniqueness and
associating actions with existing incidents.
:param \*\*properties:
:param \\*\\*properties:
Additional properties to set, i.e. if ``action`` is ``trigger``
this would include ``payload``
:type action: str
Expand Down Expand Up @@ -834,7 +834,7 @@ def send_change_event(self, **properties):

See: https://developer.pagerduty.com/docs/events-api-v2/send-change-events/

:param \*\*properties:
:param \\*\\*properties:
Properties to set, i.e. ``payload`` and ``links``
:returns:
The response ID
Expand Down Expand Up @@ -1322,7 +1322,7 @@ def rdelete(self, resource, **kw):
The path/URL to which to send the request, or a dict object
representing an API resource that contains an item with key ``self``
whose value is the URL of the resource.
:param \*\*kw:
:param \\*\\*kw:
Keyword arguments to pass to ``requests.Session.delete``
:type path: str or dict
"""
Expand All @@ -1338,7 +1338,7 @@ def rget(self, resource, **kw):
The path/URL to which to send the request, or a dict object
representing an API resource that contains an item with key ``self``
whose value is the URL of the resource.
:param \*\*kw:
:param \\*\\*kw:
Keyword arguments to pass to ``requests.Session.rget``
:returns:
Dictionary representation of the object.
Expand All @@ -1358,7 +1358,7 @@ def rpost(self, path, **kw):
:param path:
The path/URL to which to send the POST request, which should be an
index endpoint.
:param \*\*kw:
:param \\*\\*kw:
Keyword arguments to pass to ``requests.Session.post``
:returns:
Dictionary representation of the created object
Expand All @@ -1377,7 +1377,7 @@ def rput(self, resource, **kw):
The path/URL to which to send the request, or a dict object
representing an API resource that contains an item with key ``self``
whose value is the URL of the resource.
:param \*\*kw:
:param \\*\\*kw:
Keyword arguments to pass to ``requests.Session.put``
:returns:
Dictionary representation of the updated object
Expand Down