docs: Fix context example syntax and improve clarity #700
Conversation
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
…rrect Output guardrail first step. Enhanced the documentation for input and output guardrails by specifying that input guardrails apply only to the first agent in a sequence, while output guardrails apply only to the last agent. This clarification improves understanding of how guardrails function in agent chains.
Updated the documentation in context.md to enhance clarity by modifying the example of passing context to the run methods. The change specifies the syntax more clearly, improving understanding for users.
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
This Pull Request corrects a minor syntax error found in the documentation for the "Context management" section.
Changes Made
Runner.run. The incorrect exampleRunner.run(..., **context=whatever**)has been updated to correctly showRunner.run(..., context=your_context_object).Motivation
This correction provides an accurate code example in the documentation, preventing potential confusion for users and reflecting the correct way to use the
contextparameter.