Small Documentation fix for graph.md "Example: Human in the loop." #1280
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
The https://ai.pydantic.dev/graph/#example-human-in-the-loop example is a little bit wrong. With ai_q_and_a_graph.py given above ai_q_and_a_run.py code is wrong answer: str | None = sys.argv[2] if len(sys.argv) > 2 else None should be answer: str | None = sys.argv[1] if len(sys.argv) > 1 else None because we only need 1 argument for answer So explanation bellow (This example is complete, it can be run "as is" with Python 3.10+ — you'll need to add asyncio.run(main(answer)) to run main) is wrong Also asyncio.run(main(answer)) should be asyncio.run(main()) because main() in ai_q_and_a_run.py does not accept arguments So its not can be run "as is" because either ai_q_and_a_run.py needs changes or above ai_q_and_a_graph.py example should include sub_command = sys.argv[1] assert sub_command in ('continuous', 'cli', 'mermaid')
PR Change SummaryCorrected the argument handling in the example code for the AI Q&A documentation and updated the accompanying explanation.
Modified Files
How can I customize these reviews?Check out the Hyperlint AI Reviewer docs for more information on how to customize the review. If you just want to ignore it on this PR, you can add the Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add |
|
thanks so much |
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.
With
ai_q_and_a_graph.pygiven aboveai_q_and_a_run.pycode is wronganswer: str | None = sys.argv[2] if len(sys.argv) > 2 else Noneshould be
answer: str | None = sys.argv[1] if len(sys.argv) > 1 else NoneWe only need 1 argument for answer
(This example is complete, it can be run "as is" with Python 3.10+ — you'll need to add asyncio.run(main(answer)) to run main)is wrong.asyncio.run(main(answer))should beasyncio.run(main())becausemain()inai_q_and_a_run.pydoes not accept arguments.Issue: #1279