Repository navigation
Conversation
|
|
Contributor
There was a problem hiding this comment.
🔍 Devin Review: 1 flag
Not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Four docstrings name a parameter that the function below them does not accept. No runtime change: the signatures stay exactly as they are, only the prose is corrected.
livekit-agents/livekit/agents/tokenize/utils.pywordsreplacementslivekit-plugins/livekit-plugins-google/.../realtime/realtime_api.pytoolstool_behavior,tool_response_schedulinglivekit-plugins/livekit-plugins-ultravox/.../realtime/realtime_model.pymodel_idmodellivekit-plugins/livekit-plugins-upliftai/.../tts.pysample_rateDEFAULT_SAMPLE_RATEtotts.TTSitself)How this was found
A small AST check over
Args:/ numpydocParametersblocks that reports documentation entries whose name is not an argument of the enclosing function. Each hit was then read by hand against the signature; the four above are the ones that survived, i.e. where the body does not read the name back out of**kwargsand there is no overload union hiding it.Notes on the individual edits
replace_words: the body already usesreplacements, sowordsin the docstring is a rename leftover.update_options(google realtime): the two parameters were added with the tool-behaviour work and are already documented with this wording onRealtimeModel.__init__in the same file, so the wording is copied from there rather than invented.Ultravox RealtimeModel.__init__: only the firstParametersentry is wrong; the remaining entries match the signature.Uplift TTS.__init__: thesample_rateentry is deleted rather than reworded, because the argument is not part of this constructor at all — the class forwardsDEFAULT_SAMPLE_RATEto the base class.Verification
ruff checkandruff format --checkon the four touched files: clean.git diff --stat: 4 files, 4 insertions, 4 deletions.pdocoutput for these symbols gains no new section.Deliberately not touched
The same check reported nothing else in the four packages above, so the diff stays at these four docstrings. If you would rather have one pass over all of
livekit-pluginsin a single PR, say so and I will rerun it there instead.