docs: correct the sample-status version banner (rel-1.16.0 does not exist) - #46
Merged
Conversation
…xist) doc/cookbook/sample-status.md claimed "Verified against dp-grpc rel-1.16.0", but that tag has never been cut -- the newest dp-grpc release is rel-1.15.0. Copilot caught the identical overclaim in the datasets recipe during the review of #45; that one was corrected there, and this one was left alone as it was not that PR's file. Fixing it now, before the release, since a banner naming a nonexistent tag is exactly what a reader checks first. Separates the two claims the old banner conflated: the TARGET API version (1.16.0, unreleased) from what was actually exercised (a pre-release Annotation Service built from dp-service main). The verification section lower in the file and the matching CLAUDE.md line get the same treatment. Unlike the datasets recipe, no dp-service commit was recorded for the sample status integration run, so this does not name one rather than inventing a plausible sha. Worth recording the commit next time that suite is run against a live server. The four dp-python-lib 1.15.0 banners on the other recipes are accurate -- that release exists -- and are left as they are. 103 cookbook snippets check; 719 unit tests pass; ruff clean. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019he3UCsAnqTDE2VQ73Djwn
There was a problem hiding this comment.
🟢 Approval recommended
The change is documentation-only and corrects a factual versioning claim; the only remaining feedback is a minor line-wrapping readability nit.
Pull request overview
Updates the sample-status cookbook and repository guidance to avoid referencing a nonexistent dp-grpc tag, and to more precisely describe what the sample status docs were verified against.
Changes:
- Replaces the “Verified against dp-grpc
rel-1.16.0” banner with separate “Target API version” and “Verified against” statements. - Clarifies the verification section to specify a dp-service
mainpre-release server (1.16.0 API) rather than a released dp-grpc tag. - Aligns the corresponding statement in
CLAUDE.mdwith the same clarification.
File summaries
| File | Description |
|---|---|
| doc/cookbook/sample-status.md | Corrects the version/verification banner and updates the verification section wording to avoid claiming verification against a nonexistent dp-grpc tag. |
| CLAUDE.md | Updates the sample-status integration verification note to match the corrected “pre-release dp-service main” wording. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…e width The previous commit collapsed that bullet onto a single 227-column line, against the ~120-column hard wrap the surrounding list uses -- its own continuation lines were already wrapped that way, so the result was visibly inconsistent and would make future diffs noisier. Rewrapped, and while there merged the two adjacent parenthetical groups the edit had left back to back into one clause. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019he3UCsAnqTDE2VQ73Djwn
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.
doc/cookbook/sample-status.mdclaims Verified against: dp-grpcrel-1.16.0— a tag that has never been cut. The newest dp-grpc release isrel-1.15.0.Copilot caught the identical overclaim in
datasets-and-annotations.mdduring the review of #45. That one was corrected there; this one was deliberately left alone as it was not that PR's file. Fixing it now, ahead of the release, since a banner naming a nonexistent tag is the first thing a reader checks.What changed
Separates the two claims the old banner conflated:
main.The verification section lower in the file and the matching
CLAUDE.mdline get the same treatment.One deliberate omission
Unlike the datasets recipe, no dp-service commit was recorded for the sample-status integration run, so this PR does not name one rather than inventing a plausible sha. Worth capturing the commit the next time that suite is run against a live server — the datasets test records
fddf692, and the same habit would help here.The four
dp-python-lib 1.15.0banners on the other recipes are accurate — that release exists — and are untouched.Verification
103 cookbook snippets check, 719 unit tests pass, ruff lint and format clean. Docs-only; no code changed.
🤖 Generated with Claude Code
https://claude.ai/code/session_019he3UCsAnqTDE2VQ73Djwn