docs(research): clarify research() returns daily rows, not hourly obs (#52)#70
Merged
helloiamvu merged 1 commit intoJun 6, 2026
Merged
Conversation
…#52) A user asked why research() returns daily means and how to access hourly station observations. Clarify in the Returns section that research() yields one daily settlement-summary row per date (obs_* are window aggregates), not sub-daily rows, and point to weather.obs() and the Sprint 0.5+ raw_metar roadmap.
|
📝 Docs-required check: REMINDER API-surface change without docs and no opt-out — surfacing reminder. API-surface files changed: Docs files changed: Docs surfaces to consider
How to silence this reminder
This check is advisory — it never blocks the merge. |
|
Parity ticket gate: FAILED See |
helloiamvu
added a commit
that referenced
this pull request
Jun 6, 2026
…h() docs (#52) Bump all three packages 1.5.2 -> 1.5.3. - #67 (#69): build_pairs_row() now discriminates OM/IEM forecasts by source instead of issued_at presence, fixing silent null temps + IEM run-selection pollution for Phase 20+ multi-source callers; closes a lookahead-leakage path for after-close OM runs. Parity gate unaffected. - #52 (#70): research() docstring clarifies daily-row return granularity.
This was referenced Jun 6, 2026
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
Addresses #52. A user asked why
research()returns daily means and how to access hourly station observations. Clarify in theReturnsdocstring thatresearch()yields one daily settlement-summary row per date (obs_*are settlement-window aggregates), not sub-daily rows.Changes
research()Returnssection: explicitly states the daily granularity, thatresearch()does not return raw hourly rows, points toweather.obs()(also daily) for obs-only frames, and notes sub-daily /raw_metaraccess is a Sprint 0.5+ item (raw METARs preserved internally for the planned re-parse workflow).Docs-only; no code behavior change.
Review
Codex (gpt-5.5, medium) — clean, no findings.
TS Parity
N/A — docstring-only clarification, no API surface change.