codex

mirror of https://github.com/openai/codex.git synced 2026-04-24 06:35:50 +00:00

Files

Abkari Mohammed Sayeem 326c1e0a7e Fix documentation errors for Custom Prompts named arguments and add canonical examples (#5910 )

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 #4470 and #4474
for initial implementation, #5332 and #5403 for clarifications).

This addresses issue #5039 by providing complete, accurate documentation
for named argument usage in custom prompts.

---------

Co-authored-by: Eric Traut <etraut@openai.com>

2025-11-15 09:25:46 -08:00

advanced.md

docs: Fix code fence and typo in advanced guide (#6295 )

2025-11-06 09:00:28 -08:00

agents_md.md

docs: fix agents fallback example (#5396 )

2025-10-22 11:32:35 -07:00

authentication.md

chore: subject docs/*.md to Prettier checks (#4645 )

2025-10-03 11:35:48 -07:00

CLA.md

chore: subject docs/*.md to Prettier checks (#4645 )