Skip to content

Conversation

@Sayeem3051
Copy link

The Custom Prompts documentation (docs/prompts.md) was incomplete for named arguments:

  1. Documentation for custom prompts was incomplete - named argument usage was mentioned briefly but lacked comprehensive canonical examples showing proper syntax and behavior.

  2. Fixed by adding canonical, tested syntax and examples:

    • Example 1: Basic named arguments with TICKET_ID and TICKET_TITLE
    • Example 2: Mixed positional and named arguments with FILE and FOCUS
    • Example 3: Using positional arguments
    • Example 4: Updated draftpr example to use proper $FEATURE_NAME syntax
    • Added clear usage examples showing KEY=value syntax
    • Added expanded prompt examples showing the result
    • Documented error handling and validation requirements
  3. 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.

…anonical examples

The Custom Prompts documentation (docs/prompts.md) was incomplete for named arguments:

1. Documentation for custom prompts was incomplete - named argument usage was mentioned briefly but lacked comprehensive canonical examples showing proper syntax and behavior.

2. Fixed by adding canonical, tested syntax and examples:
   - Example 1: Basic named arguments with TICKET_ID and TICKET_TITLE
   - Example 2: Mixed positional and named arguments with FILE and FOCUS
   - Example 3: Using positional arguments
   - Example 4: Updated draftpr example to use proper $FEATURE_NAME syntax
   - Added clear usage examples showing KEY=value syntax
   - Added expanded prompt examples showing the result
   - Documented error handling and validation requirements

3. Added Implementation Reference section that references the relevant feature implementation from the codebase (PRs openai#4470 and openai#4474 for initial implementation, openai#5332 and openai#5403 for clarifications).

This addresses issue openai#5039 by providing complete, accurate documentation for named argument usage in custom prompts.
@github-actions
Copy link

github-actions bot commented Oct 29, 2025

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@Sayeem3051
Copy link
Author

I have read the CLA Document and I hereby sign the CLA

@Sayeem3051
Copy link
Author

recheck

github-actions bot added a commit that referenced this pull request Oct 29, 2025
Copy link
Collaborator

@etraut-openai etraut-openai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution. I think there is a need for more documentation here. Here are a few suggestions:

  1. You've included four examples. That's a bit much. Could you pare it down to two examples — perhaps a simple one and a more advanced one?
  2. I don't think the "Implementation reference" section belongs in the public docs. Recommend deleting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants