Skip to content

Commit

Permalink
Fix missing docparams in services/timer/
Browse files Browse the repository at this point in the history
  • Loading branch information
sirosen committed Aug 27, 2023
1 parent bac486d commit fa6d815
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/globus_sdk/services/timer/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ def list_jobs(
"""
``GET /jobs/``
:param query_params: additional parameters to pass as query params
:type query_params: dict, optional
**Examples**
>>> timer_client = globus_sdk.TimerClient(...)
Expand All @@ -56,6 +59,11 @@ def get_job(
"""
``GET /jobs/<job_id>``
:param job_id: the ID of the timer ("job")
:type job_id: str or UUID
:param query_params: additional parameters to pass as query params
:type query_params: dict, optional
**Examples**
>>> timer_client = globus_sdk.TimerClient(...)
Expand All @@ -71,6 +79,9 @@ def create_job(
"""
``POST /jobs/``
:param data: a timer document used to create the new timer ("job")
:type data: dict or :class:`~.TimerJob`
**Examples**
>>> from datetime import datetime, timedelta
Expand All @@ -94,6 +105,11 @@ def update_job(
"""
``PATCH /jobs/<job_id>``
:param job_id: the ID of the timer ("job")
:type job_id: str or UUID
:param data: a partial timer document used to update the job
:type data: dict
**Examples**
>>> timer_client = globus_sdk.TimerClient(...)
Expand All @@ -109,6 +125,9 @@ def delete_job(
"""
``DELETE /jobs/<job_id>``
:param job_id: the ID of the timer ("job")
:type job_id: str or UUID
**Examples**
>>> timer_client = globus_sdk.TimerClient(...)
Expand Down

0 comments on commit fa6d815

Please sign in to comment.