Repository navigation
docs: remove Korean and AI-style comments - #13
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: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:
.pyfiles, theast.dumpof the module with docstrings removed is the same before and after.uvx ruff@0.17.1 checkanduvx 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.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 ofablation.py,make_report_figures.py,metrics_report.pyandplot_ablation.pyhold usage text and were kept in English.Outside the rule (Korean string literals left unchanged): print/log/UI strings in
main.py,runs/exp01toexp07(for examplemain.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), andsrc/reflecto_exp/physics_utils.py,simulate/simul_refnx.py,simulate/torch_engine/model_utils.py,refl_utils.py. This includes the argparsedescriptionofexp07_fourier_hires/metrics_report.py.pyproject.tomlcomments are not read by the checker and were not touched.