Fix documentation errors for Custom Prompts named arguments and add canonical examples #5910
+102
−7
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.
The Custom Prompts documentation (docs/prompts.md) was incomplete for named arguments:
Documentation for custom prompts was incomplete - named argument usage was mentioned briefly but lacked comprehensive canonical examples showing proper syntax and behavior.
Fixed by adding canonical, tested syntax and examples:
Added Implementation Reference section that references the relevant feature implementation from the codebase (PRs Custom prompt args (numeric) #4470 and Named args for custom prompts #4474 for initial implementation, fix: improve custom prompt documentation and actually use prompt descriptions #5332 and docs: clarify prompt metadata behavior #5403 for clarifications).
This addresses issue #5039 by providing complete, accurate documentation for named argument usage in custom prompts.