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

docs: improve README formatting and fix typos #105

Merged
merged 3 commits into from
Jul 5, 2024
Merged

docs: improve README formatting and fix typos #105

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99d05ec
docs: improve README formatting and fix typos
andrii-balitskyi Jul 3, 2024
07614b1
Update README.rst
andrii-balitskyi Jul 4, 2024
c48f05b
Merge branch 'main' of github.com:seamapi/python-next into improve-re…
andrii-balitskyi Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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).
Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -210,7 +211,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
Expand Down