Repository navigation
docs: declare the selected-window path public for walk-forward use, with a doc-lint rule that holds it - #564
Merged
Merged
Conversation
…ith a doc-lint rule that holds it Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
luisleo526
marked this pull request as ready for review
October 27, 2026 20:24
Corrects four comments that no longer match the code they describe, and one stale line number in a script comment: - scripts/ci_verify.py: the selected-sink memory test is registered at its current line of tests/CMakeLists.txt. - tests/test_scratch_create_pinned_text.cpp: the header names the files that produce the pinned create diagnostics instead of a release. - src/source/pine_adapter.cpp: the placement table scans the retained placements and consults the historical minima for erased rows; it has no per-id index. - include/pineforge/native_host.hpp: the live-order read comment no longer claims the reads allocate nothing, since a spilled row is read into a buffer. No code changes. Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
… path it pins The header named two producing files; the test also pins the id-pair scratch file and the successor-roots create. It now lists all four scratch paths by what they are, and drops a stale note about an unobserved prediction. Comment text only. Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
… capital export edit The export added to the report writer moved the argument parser and the selected-window helpers of docker/run_json.py by 16 lines (17 for the parser's flags), so eleven citations in the public contract page pointed at neighbouring lines. They cite the same functions and flags again. Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
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
Declares the selected-window path a public surface for walk-forward use.
docs/pages/public-contract.mdgets a new section ({#selected_windows_walk_forward}) that says, from what the tree shows:docker/run_json.pyselected-window options and--capabilities-json, the capability record (capabilities.selected_window_contract_revisions), the report policy, and the two C headersselected_window.handselected_window_plan.hwith thePF_APIfunctions each declares;It also adds a pointer from the README and a line under 1.8.0 in the changelog.
A new
doc-lintrule holds the section: it reads the completePF_APIdeclarations of both headers and the selected-windowadd_argumentblock ofdocker/run_json.pyat run time (parsing the CLI withast, never importing it), and fails when the section is missing or duplicated, when a name the sources declare is absent from it, or when a source cannot be read or parsed. No name list is typed into the checker. Six cases inscripts/test_check_doc_lint.pycover it with temporary trees the test builds.Verification
cannot read or parse the selected-window public section: expected one {#selected_windows_walk_forward} section(one offender) when the three documentation files are reverted and the checker is kept.ci_preflight(59 stages, including doc-anchors, doc-lint and doc-reverts) and the documentation build pass.🤖 Generated with Claude Code