Closed dvonthenen closed 1 week ago
[!WARNING]
Rate limit exceeded
@dvonthenen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 34 seconds before requesting another review.
How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.Commits
Files that changed from the base of the PR and between c6b7e334f3b587c214f071c2d88ee229cb605eb4 and ed7c00eabb94c12d90ce788e1ff6db68f5a19307.
The updates primarily focus on enhancing the documentation across various README.md files in the deepgram-python-sdk repository. These changes include adding installation instructions for dependencies, clarifications regarding platform compatibility, and ensuring consistency in platform naming conventions. No changes were made to the declarations of exported or public entities.
Files | Change Summary |
---|---|
README.md | Added instructions to install dependencies before running examples. |
examples/README.md | Added a note about microphone examples potentially not working on Windows due to portaudio dependency. |
examples/streaming/legacy_dict_microphone/README.md | Specified that the example only works on Linux and macOS, excluding Windows. |
examples/streaming/async_microphone/README.md | Updated platform names from "MacOS" to "macOS" for consistency. |
examples/streaming/microphone/README.md | Updated platform names from "MacOS" to "macOS" for consistency. |
In README's lines, dependencies now show,
For Python's voice, instructions help you grow.
On Linux, macOS, the streams will flow,
But Windows needs a tweak, as we all know.
With names aligned, consistency we sow,
Documentation shines, like a rabbit's glow.
šāØš
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Proposed changes
Addresses: https://github.com/deepgram/deepgram-python-sdk/issues/340
This clarifies the local Microphone example support for Windows. Since they are only examples and best effort because the portaudio installation (which the user is responsible for) is a little tricky.
Types of changes
What types of changes does your code introduce to the community Python SDK? Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments
NA
Summary by CodeRabbit
legacy_dict_microphone
example README to specify it only works on Linux and macOS.async_microphone
andmicrophone
example READMEs.