From 99d05ec4e0dae9307be1b138feb4cfab35a8a320 Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Wed, 3 Jul 2024 10:36:19 +0200 Subject: [PATCH 1/2] docs: improve README formatting and fix typos --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index ba1ca2c..737ec20 100644 --- a/README.rst +++ b/README.rst @@ -103,7 +103,7 @@ A workspace ID must be provided when using this method and all requests will be .. code-block:: python - # Pass as an option the constructor + # Pass as an option to the constructor seam = Seam( personal_access_token="your-personal-access-token", workspace_id="your-workspace-id", @@ -126,7 +126,7 @@ when it succeeds or fails. To make working with action attempts more convenient for applications, this library provides the ``wait_for_action_attempt`` option and enables it by default. -When the ``wait_for_action_attempt`` option is enable, the SDK: +When the ``wait_for_action_attempt`` option is enabled, the SDK: - Polls the action attempt up to the ``timeout`` at the ``polling_interval`` (both in seconds). @@ -151,7 +151,7 @@ Or, to get the current state of an action attempt by ID without waiting, wait_for_action_attempt=False, ) -To disable this behavior, set the default option for the client, +To disable this behavior, set the default option for the client: .. code-block:: python @@ -162,7 +162,7 @@ To disable this behavior, set the default option for the client, seam.locks.unlock_door(device_id=device_id) -or the behavior may be configured per-request, +or the behavior may be configured per-request: .. code-block:: python @@ -171,7 +171,7 @@ or the behavior may be configured per-request, wait_for_action_attempt=False, ) -The ``polling_interval`` and ``timeout`` may be configured for the client or per-request, for example +The ``polling_interval`` and ``timeout`` may be configured for the client or per-request. For example: .. code-block:: python @@ -210,7 +210,7 @@ A Personal Access Token is scoped to a Seam Console user. Obtain one from the Se .. code-block:: python - # Pass as an option the constructor + # Pass as an option to the constructor seam = SeamMultiWorkspace(personal_access_token="your-personal-access-token") # Use the factory method From 07614b1d8b7d3911da5223fbe43e195f2a9cc2f5 Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <84702959+andrii-balitskyi@users.noreply.github.com> Date: Thu, 4 Jul 2024 16:43:33 +0200 Subject: [PATCH 2/2] Update README.rst Co-authored-by: Evan Sosenko --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 737ec20..0a2189f 100644 --- a/README.rst +++ b/README.rst @@ -171,7 +171,8 @@ or the behavior may be configured per-request: wait_for_action_attempt=False, ) -The ``polling_interval`` and ``timeout`` may be configured for the client or per-request. For example: +The ``polling_interval`` and ``timeout`` may be configured for the client or per-request. +For example: .. code-block:: python