Skip to content

docs: remove Korean and AI-style comments - #13

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

Copy link
Copy Markdown
Owner

Tier: low.

Comment and docstring changes only. No code, string literal, notebook, config or README change.

Checker (.github/tools/conventions.py, comment_findings), run with Python 3.13, no unparsed-file warning:

rule before after
comments or docstrings in Korean 538 0
numbered step comments 188 0
banner comments 201 0
Note:/Important: comments 4 0

No skipped files: there are no open PRs, and the four unmerged remote branches (chore/drop-stale-path, docs/lineage-audit, fix/append-timestamp, fix/exp07-genx-background) are the heads of PRs #2, #10, #8 and #11, which are already merged.

Of the 843 flagged comments and docstrings, 644 were deleted (restated the next line, numbered steps, banners, change notes) and 199 were kept as short English comments or docstrings (reasons, units, constraints, GenX/physics notes, module usage text). Roughly three quarters deleted, one quarter kept.

Verification:

  • AST identical (73 files): for all 100 tracked .py files, the ast.dump of the module with docstrings removed is the same before and after.
  • uvx ruff@0.17.1 check and uvx ruff@0.17.1 format --check: pass. Removing comments between import groups left three blocks that isort wanted tightened (exp05_1layer_mask/evaluate.py, evaluate2.py, exp07_fourier_hires/analyze.py); the blank line was removed in those.
  • Not run locally: pytest (the CI job installs torch with CUDA wheels, far over the local size budget); left to CI.

Docstrings and CLI help: no __doc__ use. The module docstrings of ablation.py, make_report_figures.py, metrics_report.py and plot_ablation.py hold usage text and were kept in English.

Outside the rule (Korean string literals left unchanged): print/log/UI strings in main.py, runs/exp01 to exp07 (for example main.py, exp02_one_layer/train.py, exp03_physics_fused/test/test.py, exp05_1layer_mask/inference_pipeline.py, exp07_fourier_hires/ablation.py, make_report_figures.py, metrics_report.py), and src/reflecto_exp/physics_utils.py, simulate/simul_refnx.py, simulate/torch_engine/model_utils.py, refl_utils.py. This includes the argparse description of exp07_fourier_hires/metrics_report.py. pyproject.toml comments are not read by the checker and were not touched.

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