Skip to content

Commit e7b2dbf

Browse files
docs: improve README formatting and fix typos (#105)
* docs: improve README formatting and fix typos * Update README.rst Co-authored-by: Evan Sosenko <evan@getseam.com> --------- Co-authored-by: Evan Sosenko <evan@getseam.com>
1 parent 4c611a5 commit e7b2dbf

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

README.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ A workspace ID must be provided when using this method and all requests will be
103103

104104
.. code-block:: python
105105
106-
# Pass as an option the constructor
106+
# Pass as an option to the constructor
107107
seam = Seam(
108108
personal_access_token="your-personal-access-token",
109109
workspace_id="your-workspace-id",
@@ -126,7 +126,7 @@ when it succeeds or fails.
126126
To make working with action attempts more convenient for applications,
127127
this library provides the ``wait_for_action_attempt`` option and enables it by default.
128128

129-
When the ``wait_for_action_attempt`` option is enable, the SDK:
129+
When the ``wait_for_action_attempt`` option is enabled, the SDK:
130130

131131
- Polls the action attempt up to the ``timeout``
132132
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,
151151
wait_for_action_attempt=False,
152152
)
153153
154-
To disable this behavior, set the default option for the client,
154+
To disable this behavior, set the default option for the client:
155155

156156
.. code-block:: python
157157
@@ -162,7 +162,7 @@ To disable this behavior, set the default option for the client,
162162
163163
seam.locks.unlock_door(device_id=device_id)
164164
165-
or the behavior may be configured per-request,
165+
or the behavior may be configured per-request:
166166

167167
.. code-block:: python
168168
@@ -171,7 +171,8 @@ or the behavior may be configured per-request,
171171
wait_for_action_attempt=False,
172172
)
173173
174-
The ``polling_interval`` and ``timeout`` may be configured for the client or per-request, for example
174+
The ``polling_interval`` and ``timeout`` may be configured for the client or per-request.
175+
For example:
175176

176177
.. code-block:: python
177178
@@ -210,7 +211,7 @@ A Personal Access Token is scoped to a Seam Console user. Obtain one from the Se
210211

211212
.. code-block:: python
212213
213-
# Pass as an option the constructor
214+
# Pass as an option to the constructor
214215
seam = SeamMultiWorkspace(personal_access_token="your-personal-access-token")
215216
216217
# Use the factory method

0 commit comments

Comments
 (0)