Skip to content

docs: clarify fetch vs classify date windows#51

Merged
ghinks merged 1 commit into
mainfrom
docs/clarify-fetch-classify-date-windows
May 1, 2026
Merged

docs: clarify fetch vs classify date windows#51
ghinks merged 1 commit into
mainfrom
docs/clarify-fetch-classify-date-windows

Conversation

@ghinks
Copy link
Copy Markdown
Owner

@ghinks ghinks commented May 1, 2026

Summary

  • Renames --start/--end option descriptions from "classification window" to "statistics baseline window" — the old label was ambiguous since the evaluation period is also part of classifying
  • Expands the window section to make explicit that PRs merged after --end are what get evaluated and reported, not the ones inside the baseline
  • Adds a combined diagram showing how the fetch date range must span both the baseline period and the post---end evaluation period
  • Adds an Important callout warning that if you only fetch up to your classify --end date, there will be no PRs left to report
  • Fixes the end-to-end example which mistakenly used the same end date for both fetch and classify (e.g. --collate-end 2024-12-31 paired with --end 2024-12-31), which would leave nothing to evaluate

Test plan

  • Review README renders correctly on GitHub
  • Diagram and callout are legible in both terminal and markdown

🤖 Generated with Claude Code

- Rename --start/--end option descriptions from "classification window"
  to "statistics baseline window" to make their purpose unambiguous
- Expand the window section to explain that PRs *after* --end are the
  ones evaluated, not the ones in the baseline
- Add a combined diagram showing how fetch and classify date ranges
  must relate to each other
- Add an explicit warning that the fetch window must extend beyond the
  classify --end date or there will be no PRs to evaluate
- Fix the end-to-end example which mistakenly used the same end date
  for both fetch and classify (leaving nothing to report)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@ghinks ghinks merged commit 159eed5 into main May 1, 2026
1 check passed
@ghinks ghinks deleted the docs/clarify-fetch-classify-date-windows branch May 1, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant