Repository navigation
docs: the package is a Filing Ladder rung since v0.2; --pure is v0.1.1's read cap, not the rung's profile - #106
Merged
Merged
Conversation
…1's read cap, not the rung's profile The README's ladder paragraph said the package built the benchmark's corpus; since protocol v0.2 it is also rung 4c, xbrlkit serve over one filing, measured beside the hosted graph's tools on the same questions, and the paragraph now says so and points at the ladder's one table. The serve README and the module docstring said --pure is the profile a benchmark rung runs under; the rung ran the default product profile with the document on, and --pure is v0.1.1's read cap kept for replication.
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.
Summary
Three sentences about the Filing Ladder brought up to date with its v0.2 and v0.2.1 runs (November 2026). The README's ladder paragraph said the package built the benchmark's corpus and that each projection is a rung; since protocol v0.2 the package is also a rung of its own (
xbrlkit serveover one filing, rung 4c), and the paragraph now says so in one sentence and points at the ladder's one table of every published row. TheserveREADME and the server module docstring said--pureis "the profile a benchmark rung runs under"; it is not — the ladder's serve rung ran the default product profile with the document on, and--pureis v0.1.1's read cap kept for replication. Both corrected.Changes
README.md— the Filing Ladder paragraph: the package as a rung since v0.2, same accuracy as the hosted graph's tools on the same questions, the published table carrying its cost per correct answer, the two argument aliases (0.21.5) as the first thing the transcripts fed back, and the corpus-as-test-bench sentences kept.xbrlkit/serve/README.md— the--pureparagraph: v0.1.1's read cap, kept for replication; the serve rung ran the product profile.xbrlkit/serve/server.py— the module docstring'spurebullet, the same correction.Output Impact
INTERNAL — documentation only; nothing emitted or served changes.
Testing
just test-allgreen (the README-token test intests/test_server_json.pystill passes; no code touched). The claims are checked against the ladder's PROTOCOL §11 (the 4c lock: "Product profile, the document on — whatuvx xbrlkit serve <package>gives any reader";--purerecorded, not run) andresults/README.mdat tagresults-v0.2.1.