Skip to content

docs: quote the current §4.6 and §9.1 text for the seed adoption window - #185

Open
anandhu-eng wants to merge 1 commit into
mainfrom
docs/seed-adoption-window-quote
Open

anandhu-eng wants to merge 1 commit into
mainfrom
docs/seed-adoption-window-quote

Conversation

@anandhu-eng

Copy link
Copy Markdown
Collaborator

Fixes #164.

The adoption_window docstring quoted §4.6 as "four consecutive cohorts — its publication cohort and the following three". That sentence is not in the rules, and never was in the file's history.

The docstring now quotes the rules as written:

  • §4.6 (Submission Rules): "Each published seed set is available for adoption by new submissions until 4 cohort dates have passed and is then dropped from the sets available for adoption."
  • §9.1 (Rules): the set "must have been published for target_cohort or one of the three immediately preceding cohorts".

§9.1 settles that the window is the publication cohort plus the three after it. That matches the code and the published seedset.yaml (set B: 2026-11-C0 to 2026-12-C1).

The same paraphrase is also fixed in the cohorts.py module docstring and the seed_sets.yaml header. No logic change. Tests, ruff and mypy pass.

🤖 Generated with Claude Code

The adoption_window docstring quoted "four consecutive cohorts — its
publication cohort and the following three", which is not in the rules.
It now quotes §4.6 and the §9.1 check that sets the window. The module
docstring and the seed_sets.yaml header are updated to match. No logic
change.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported for the documentation update clarifying the seed-adoption window.

No open issues 🎉

What changed in this PR

Updates seed-adoption-window documentation to use the published rules’ wording, addressing #164 without changing behavior.

Changes:

  • Replaces the inaccurate §4.6 quotation with the current text.
  • Cites §9.1 to clarify that adoption includes the publication cohort and the next three cohorts.
  • Aligns the module docstring and seed-set header comments with these references.
File Description
src/​submission_checker/​data/​seed_sets.yaml Updates the header comment to cite both sections for the adoption window.
src/​submission_checker/​cohorts.py Corrects the §4.6 quotations and adds §9.1’s justification for the existing window.

Review effort: Balanced

This branch has not been deployed

No deployments
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.

Seed adoption window: docstring quotes §4.6 wording that is not in the current rules

2 participants