Scope the contract-only usage claims and fix the run-usage example#9
Merged
Conversation
…mple Review follow-ups raised on the TypeScript mirror of this page; the same three defects were present here, so both SDKs stay in sync. - Drop a dead link to the protocol spec. It pointed at a path that does not exist in the public runtime repo, and the spec's real home is an internal repo, so there is no public target to redirect to — reference the spec and its section by name instead. While there, correct the brand: the record is a Pipelex runtime concept, not part of the MTHDS standard, which says nothing about usage reporting. - Make the example meaningful. `mthds_contents=[...]` parses in Python but passes an `Ellipsis` where a bundle source is expected; a registered `pipe_code` with `inputs` is both valid and the more idiomatic hosted call. - Scope two guarantees that the page stated absolutely while documenting their exception further down. The spec qualifies both with "on a record emitted under this contract": pre-contract artifacts are relayed verbatim, so they do carry a raw `unit_costs` rate table and `job_metadata`. Name the exemption at both claims rather than only at the compatibility section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
No issues found across 1 file
You’re at about 98% of the monthly reviewed-line limit. You may want to disable incremental reviews to conserve quota. Reviews will continue until that limit is exceeded. If you need help avoiding interruptions, please contact contact@cubic.dev.
Greptile SummaryThis PR corrects and clarifies the run-usage documentation. The main changes are:
Confidence Score: 5/5This looks safe to merge. No blocking issues found in the changed documentation.
What T-Rex did
Important Files Changed
Reviews (1): Last reviewed commit: "docs(usage): scope the contract-only cla..." | Re-trigger Greptile |
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.
Follow-up to #8. Review on the TypeScript mirror (pipelex-sdk-js#14) surfaced three defects on the run-usage page; the same text shipped here, so this keeps the two SDK docs in sync.
Dead spec link. The page linked to
docs/specs/pipelex-mthds-protocol.mdin the public runtime repo, where that path does not exist — the spec lives in the internal workspace repo, so there is no public target to redirect to. The link is replaced by a by-name reference to the spec and its section.While there: the page called this "the MTHDS protocol spec". The public MTHDS protocol spec says nothing about usage reporting — the record is a Pipelex runtime concept. Corrected per the brand boundary.
Broken example.
mthds_contents=[...]parses in Python but passes anEllipsiswhere a bundle source string is expected. A registeredpipe_codewithinputsis valid and is the more idiomatic hosted call (the protocol requires at least one ofpipe_code/mthds_contents).Two guarantees stated absolutely, then contradicted. The page said the rate table "never crosses the wire" and that
job_metadataet al. "must never appear on a record" — then documented, further down, that pre-contract artifacts are relayed verbatim and do carry exactly those. The spec qualifies both claims with "on a record emitted under this contract" and names the exemption; this page now does the same at both claims instead of only in the compatibility section. Matchesconformance/usage_records.py, where the legacy record is deliberately excluded from the leak guard as "the documented MUST-NOT exemption, not a leak".Docs only — no code, no contract change.
make agent-checkandmake agent-testpass.🤖 Generated with Claude Code
Summary by cubic
Update run-usage docs to fix a bad example and remove a dead spec link, and to scope contract-only guarantees correctly. Aligns Python docs with the
@pipelex/sdkmirror.pipe_codewithinputsinstead ofmthds_contents=[...].unit_costs,job_metadata).Written for commit 0b04c93. Summary will update on new commits.