docs: headline the 1.17 pairs()/align ladder; demote dataset()/research() to legacy#126
Open
helloiamvu wants to merge 2 commits into
Open
docs: headline the 1.17 pairs()/align ladder; demote dataset()/research() to legacy#126helloiamvu wants to merge 2 commits into
helloiamvu wants to merge 2 commits into
Conversation
…ch() to legacy - README intro, quickstart, and 'what you can build' now lead with weather.pairs() + the three-rung align ladder (snippets verified executable offline against the shipped 1.17 surface); markets examples moved to kalshi/polymarket.pairs(); stale D-22 FutureWarning note removed (the flip was cancelled in 1.17); docs index promotes the migration guide and marks docs/dataset.md as the legacy composer doc. - docs/dataset.md gets a legacy-surface banner; docs/ts-quickstart.md gets a TS-on-1.17 note (research()/dataset() current THERE, ladder Python-only, PT-3401). - BYO-spine example documents the date join-key requirement (the raw-MergeError UX gap is filed separately). No code changes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…holder, core-package description Codex findings on 19c96cc: (1) the TS-on-1.17 banner overclaimed — TS dataset() still emits the D-22 FutureWarning on omitted label (the Python flip-cancellation was not ported; divergence filed separately); (2) '<event_id>' fails _EVENT_ID_RE before any network call — placeholder is now a regex-valid slug; (3) @mostlyrightmd/core does not export research() (it lives in the mostlyright meta package). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Parity ticket gate: PASSED See |
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
Post-v1.17.0 docs refresh: the README still presented
dataset()as the flagship "alignment engine" withresearch()as its alias — both became deprecation shims in 1.17.0. No code changes.weather.pairs()and the three-rungalignladder; markets examples usekalshi.pairs()/polymarket.pairs()(withoutcome=True); the stale D-22FutureWarningnote (wrong since 34-06 cancelled the flip) is replaced with an accurate legacy note; docs index promotes the migration guide and marksdocs/dataset.mdas the legacy composer doc.dataset()still emits the D-22 warning (accurately documented), ladder is Python-only (PT-3401).Review
Codex loop (docs-with-code-fragments rule): round 1 found 2 CRITICAL + 1 HIGH (TS banner overclaimed vs shipped TS warning behavior;
<event_id>placeholder failed_EVENT_ID_REpre-network;@mostlyrightmd/coredescription claimedresearch()) — all fixed; round 2 PASS.Found along the way (filed as separate tasks, not in this PR)
datecolumn crashesalign(…, weather.obs(…))with a raw pandasMergeErrorinstead of a style-guideContractError.dataset()still promises the 2.0 label-default flip that Python cancelled — cross-SDK 2.0 parity risk.🤖 Generated with Claude Code