Fix two docstring mismatches in ConversationHistory.build_context - #2475
Open
Anton Karpov (karpovantonme) wants to merge 1 commit into
Open
Fix two docstring mismatches in ConversationHistory.build_context#2475Anton Karpov (karpovantonme) wants to merge 1 commit into
Anton Karpov (karpovantonme) wants to merge 1 commit into
Conversation
The docstring names user_queries_only; the parameter is include_user_turns_only. It also says max_qa_turns defaults to 1 while the signature has 5.
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.
Description
Two things in the
ConversationHistory.build_contextdocstring do not match the signature.user_queries_onlydoes not exist, the parameter isinclude_user_turns_onlyand that is the name used in the body. Andmax_qa_turnsis documented as defaulting to 1 while the signature says 5, so anyone relying on the docstring gets the truncation point wrong.Related Issues
None.
Proposed Changes
user_queries_onlyrenamed toinclude_user_turns_onlymax_qa_turnscorrected from 1 to 5Checklist
Additional Notes
tokenizerandmax_context_tokensare not documented at all, which is a separate thing and I left it alone