Trim llm-cost READMEs: drop deprecated calibrate section, cut attribution ~1/3#47
Merged
Merged
Conversation
…tion by ~1/3 - llm-cost-estimation: remove the deprecated `calibrate` API section (calibrateCoverage is the documented replacement). - llm-cost-attribution: condense prose and redundant code examples to cut the README from 388 to 276 lines (~29%) without dropping any documented API, use-case table, or valid import. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
Summary
calibrateAPI section.calibrateCoverageremains the documented replacement (the section was the only standalone doc for a placeholder that throws).What was preserved
import { … } from 'llm-cost-attribution'examples still reference real exports (required by the README↔catalog alignment check from GRV-25/29).Verification
node --test test/llm-cost-catalog-api-alignment.test.mjs— pass (2/2).npm test— full suite passes (root catalog tests, attribution incl.test:boundary, estimation).package-lock.jsonor file-mode noise.Note
The estimation README's "Ready vs planned APIs" status table still carries a one-line
Deprecated | calibraterow (self-contained — it explains the throw and namescalibrateCoverage). Left in place since the request was to remove the dedicated section; easy to drop too if you'd prefer zerocalibratementions.