Repository navigation
Chore: Ask agents to take documentation comments from official sources - #467
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copy the wording and formatting of official descriptions by default, but allow adapting or rephrasing where they don't fit a Swift documentation comment, instead of requiring them word for word. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
nezhyborets
requested review from
Krivoblotsky
and
a balanced review from Copilot
October 13, 2026 15:41
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only change is clear, consistent, and fulfills the stated purpose.
0 open findings
What changed in this PR
Adds contributor guidance requiring public API documentation to use official OpenAI sources, reducing wording drift.
Changes:
- Defines a prioritized list of official documentation sources.
- Clarifies permitted adaptations and handling of Swift-specific documentation.
| File | Description |
|---|---|
CLAUDE.md |
Adds documentation sourcing and adaptation guidance. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Krivoblotsky
approved these changes
Oct 13, 2026
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.
What
Adds a section to
CLAUDE.mdthat tells agents to copy documentation comments for public API that mirrors the OpenAI API word for word from official sources rather than writing their own. Sources, in order of preference:descriptionfields in the repository'sopenapi.yaml, which are the text of the API Reference in an easily searchable formAgents may change only names (
expires_after→expiresAfter) and make relative links absolute. Text about this SDK rather than the API, such as which method to use instead or why a type is hand-written, goes in its own paragraph. If no official source describes something, it stays undocumented and the agent says so in its summary.Why
Agent-written doc comments tend to paraphrase or invent descriptions, which can drift from the API's actual behaviour and from the wording users see in the API Reference. This came up while reviewing the Files API work in #401.
Affected Areas
CLAUDE.mdonlyMore Info
The rule is already applied to the Files API doc comments in #401.
🤖 Generated with Claude Code