Skip to content

docs(tools): delete narrating comments - #85

Merged
fjlopez merged 1 commit into
devfrom
cleanup/rt-5-narrating-comments
Oct 15, 2026
Merged

fjlopez merged 1 commit into
devfrom
cleanup/rt-5-narrating-comments

Conversation

@fjlopez

@fjlopez fjlopez commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

Why

Slice 20 lists comments under tools/bin that restate the next statement. A reader can see the statement. The notes that name a real rule stay.

What changed

  • Deleted the narrating comments in the changelog checker, codelist sorter, baseline loader, seed extractor, language switcher, seed orchestrator, and translation generator.
  • Left the oldest-commit note, the no-next-changelog rule, the language-id selector note, and the is_ancestor exception handler.

Scope

Comment text under tools/bin only. This leaves tools/i18n-utils/sort_and_complete_translations.py, because that file is outside tools/bin. It also leaves the is_ancestor exception handler.

Blast Radius

Readers of those scripts. The scripts do the same work.

Verification

  • python3 -m unittest discover -s tools/tests -p 'test_*.py' finished OK, 46 tests, one skip (filesystem is case-insensitive). None of those tests asked for a database. Playwright was listed on the earlier commits in this stack, and was not executed. This commit does not change a spec.

The comments restated the next statement. The notes that name git-log
order, the no-next-changelog rule, and the language-id selector stay.
The is_ancestor exception handler is unchanged.
@fjlopez
fjlopez changed the base branch from cleanup/rt-3-wrong-comments to dev October 15, 2026 10:05
@fjlopez

fjlopez commented Oct 15, 2026

Copy link
Copy Markdown
Contributor Author

Reopening so CI runs against dev.

@fjlopez fjlopez closed this Oct 15, 2026
@fjlopez fjlopez reopened this Oct 15, 2026
@fjlopez
fjlopez merged commit 9638472 into dev Oct 15, 2026
8 of 14 checks passed
@fjlopez
fjlopez deleted the cleanup/rt-5-narrating-comments branch October 15, 2026 13:36
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