Skip to content

docs: remove Korean, numbered and banner comments - #33

Merged
NaNIsaac merged 1 commit into
mainfrom
chore/english-comments
Oct 24, 2026
Merged

NaNIsaac merged 1 commit into
mainfrom
chore/english-comments

Conversation

@NaNIsaac

@NaNIsaac NaNIsaac commented Oct 24, 2026 •

Copy link
Copy Markdown
Owner

Tier: low.

Comments and docstrings only. Comments are English and say why; banners, numbered step comments and Korean comments are removed (BACKLOG rule 27).

Checker (conventions.py comment_findings, run with Python 3.14, no unparsed files):

rule before after
Korean comments/docstrings 35 0
numbered step comments 9 0
banner comments 82 10

The 10 banners that remain are all in tests/test_gui.py, which open PR #26 (fix/gui-arrow-key-waits) also changes, so it is skipped here. PR #26 covers them; they can be removed after it merges.

Skipped because open PRs touch them: tests/test_gui.py (#26); CHANGELOG.md and pyproject.toml (#31, not edited anyway). Other unmerged remote branches were checked: all except #26 and #31 belong to merged PRs (squash merges), and fix/gui-wait-for-model is a closed PR (#25, tests/conftest.py and tests/test_gui.py), so only the test_gui.py skip applies.

Flagged comments handled (103 lines outside the skipped file): 87 deleted, 16 kept as short English comments or docstrings (rewritten or translated). Deleted: 72 banners, 9 numbered steps, 6 Korean comments that restated the next line or were change notes (including # <--- 'msc.camera' 수정!). Kept: reasons and constraints (for example why the check-mark icon is written to a temp PNG, which side measures and which draws the ring profile) and short docstrings.

AST identical (24 files). Python AST dump with docstrings stripped, taken before and after, is identical for every changed .py file (24 of 45 tracked .py files changed; the other 21 are untouched). Only .py files changed; every diff line is a comment, docstring or blank line.

Docstrings: nothing reads __doc__/inspect, and the CLI parser descriptions were not touched, so no help text changed.

Korean strings left alone (UI, log and status text, outside the rule): in src/qoradfxm/core/ops.py, gui/control_dock.py, gui/documents.py, gui/file_dock.py, gui/image_view.py, gui/main_window.py, gui/models.py, gui/pipeline.py, gui/results_table.py, gui/results_window.py, gui/ribbon.py, gui/ring_panel.py, gui/settings_dialog.py, gui/widgets.py.

Local checks run: ruff@0.17.1 check and ruff@0.17.1 format --check (the versions from .github/workflows/lint.yml), the comment checker, and the AST equality script. Left to CI: pytest (uv.lock lists cupy and nvidia packages, so I did not run uv sync); a comment-only change cannot alter test results given the AST equality.

@NaNIsaac
NaNIsaac merged commit aee2d33 into main Oct 24, 2026
7 checks passed
@NaNIsaac
NaNIsaac deleted the chore/english-comments branch October 24, 2026 07:55
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