fix: documentation inconsistencies#6
Merged
dittos merged 3 commits intoglobalaiplatform:mainfrom Aug 20, 2025
Merged
Conversation
Correct the documentation to accurately reflect which callback events are supported by each streaming type: - Object: on_start, on_complete, on_update - List: on_start, on_complete, on_append - String: on_start, on_complete, on_append - Atom: on_start, on_complete Previously, documentation incorrectly suggested all types support on_append, on_update, and on_complete uniformly.
dittos
reviewed
Aug 20, 2025
df0787c to
ae18548
Compare
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.
Summary
This PR fixes two key documentation inconsistencies that could confuse users:
gpt-5-miniinstead ofgpt-4o-minito match the model used inexample.pyandREADME.mdChanges Made
Model Name Consistency
docs/index.mdanddocs/api/parser.mdto usegpt-5-miniin code examplesCallback Event Documentation
README.md,docs/index.md, anddocs/api/overview.mddocs/api/parser.mdshowing which events are supported by each type:on_start,on_complete,on_updateon_start,on_complete,on_appendon_start,on_complete,on_appendon_start,on_completeTest plan