Skip to content

Commit

Permalink
Update Timer Management examples per review
Browse files Browse the repository at this point in the history
Co-authored-by: Ada <107940310+ada-globus@users.noreply.github.com>
  • Loading branch information
sirosen and ada-globus committed Oct 24, 2024
1 parent 16dab87 commit 7b1321f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
9 changes: 6 additions & 3 deletions docs/examples/timer_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ Create a timer
This script creates a new timer, on source and destination collections provided
via the command-line. It syncs an input file or directory between the two.

The script assumes that the path being synced is the same on the source and
destination for simplicity.

.. note::
This example does not handle ``data_access`` scope requirements.
See the later example to handle this.
Expand All @@ -31,8 +34,7 @@ This script lists your current timers.
Delete a timer
~~~~~~~~~~~~~~

This script creates a new timer, on source and destination collections provided
via the command-line. It syncs an input file or directory between the two.
This script deletes a timer by ID.

.. literalinclude:: delete_timer.py
:caption: ``delete_timer.py`` [:download:`download <delete_timer.py>`]
Expand All @@ -50,7 +52,8 @@ Discovering ``data_access`` requirements requires the use of a

As in the simpler example, this script creates a new timer, on source and
destination collections provided via the command-line. It syncs an input
file or directory between the two.
file or directory between the two, and assumes that the path is the same on the
source and destination.

.. literalinclude:: create_timer_data_access.py
:caption: ``create_timer_data_access.py`` [:download:`download <create_timer_data_access.py>`]
Expand Down
5 changes: 3 additions & 2 deletions src/globus_sdk/services/timers/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ def add_app_transfer_data_access_scope(
"""
Add a dependent ``data_access`` scope for one or more given ``collection_ids``
to this client's ``GlobusApp``, under the Transfer ``all`` scope.
Useful for resolving ``ConsentRequired`` errors when using Globus Connect
Server mapped collections.
Useful for preventing ``ConsentRequired`` errors when creating timers
that use Globus Connect Server mapped collection(s) as the source or
destination.
.. warning::
Expand Down

0 comments on commit 7b1321f

Please sign in to comment.