docs: add Args docstrings to all judge factory functions#5957
Open
Zenvila wants to merge 1 commit into
Open
Conversation
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
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
1 participant
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 this PR does
Adds
Args:docstring sections to all 8 public judge factory functionsin
livekit/agents/evals/judge.py:Why
All judge functions accept an
llmparameter but none documentedwhat happens when
Noneis passed. Developers had no way of knowingthat passing
Nonerequires an LLM to be provided via JudgeGroup,otherwise a ValueError is raised at evaluation time.
This follows the existing pdoc3 docstring style used throughout
the codebase as required by CONTRIBUTING.md.