docs: Clarify required format for thought field - #1
Open
sruthigandhi wants to merge 1 commit into
Open
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
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.
Was testing the environment and ran into validation errors on
/stepthat were super confusing. I think
thoughtfield has a validatorthat requires both 'Observation:' and 'Plan:' sections, but this isn't
in the schema or error messages.
I think the fix is to update the Field description to make the requirement
explicit with an example. That way when someone queries
/schemaor looksat the docs, they'll see what format is expected.
Changes:
thoughtfield description in models.py to document the required formatI tested it on
/schemaendpoint and the new description shows up correctly.Let me know if this is the right approach or if there's a better way to handle it.