Improve reference docs for Server APIs #306
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I found this module to be quite difficult to use within Agents due to limited documentation.
This PR:
proto
imports that were misleading in the docs/source as the right way to import the proto classes is via api.* (they are re-exported in__init__.py
)__aenter__
and__aexit__
to LiveKitAPI so it can be used withasync with
which allows cleaner example code (lmk @theomonnom if I did this wrong, I'm not super familiar)