docs(api): document keep_recent_count param on commit() (#2284)#2315
Open
r266-tech wants to merge 2 commits into
Open
docs(api): document keep_recent_count param on commit() (#2284)#2315r266-tech wants to merge 2 commits into
r266-tech wants to merge 2 commits into
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
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.
#2284 added a keyword-only
keep_recent_count: int = 0param to the Python SDKcommit()/commit_async()/commit_session(), but the canonical commit() API reference Parameters table (EN + ZH) still lists onlysession_id.This adds the missing row in both
docs/en/api/05-sessions.mdanddocs/zh/api/05-sessions.md. Description grounded inopenviking_cli/client/base.pydocstring ("Number of recent live messages to retain after commit") + default0.Pure docs, no behavior change.