Repository navigation
docs: remove Korean and AI-style comments - #41
Merged
Merged
Conversation
Owner
Author
|
local-ci: cd9d067 | ruff ok | pytest 294 passed | cargo ok | readme dry-run ok (install step not run) |
Owner
Author
|
The failing parity test (tests/cap.rs, parity_term_renders_what_either_build_stored) is not caused by this PR: it is a timing flake, tracked in #42. The Rust build truncates the command time to whole milliseconds and the Python build rounds it, so a command under 1 ms gets no duration attribute in one build and duration=1 in the other. The same test failed on earlier runs that do not touch it (39854272241, 39855357519, and 39924534947 on main). This PR changes comments and docstrings only; no line in rust/src/runner.rs, rust/src/term.rs or the term code changed. |
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.
Brings
conventions.pycomment checks (BACKLOG rule 27) to 0 findings for this repo. Comments and docstrings only; no code, string literal, README, config or lock file changed.Findings (line hits, checker run on Python 3.15, which this repo needs to parse; older Pythons skip the files that fail to parse and under-count):
Note:/Important:What was done:
tree, why a target is resolved first, why relative imports are not cached, why the f-string intags.filestarts at column 0, the anchor limit insemdiff, and the like). TwoNote:prefixes dropped, the sentences kept._is_included, restated the name), one shortened (generate_toon, a placeholder).The Master Method:and# Helper for quick access.__doc__: none of the changed docstrings is on a command function, so help text is unchanged.Korean strings left alone (string literals, outside the rule): test fixtures with Hangul file names or text in
tests/test_agent_use.py,tests/test_remote_scan.py,tests/test_shadow.py,rust/src/output.rs,rust/src/shadow.rs,rust/src/term.rs,rust/tests/ingest.rs,rust/tests/shadow.rs. No Korean string insrc/was touched.Proof that only comments changed:
.pyfiles,ast.dumpof the module with first-statement docstrings stripped is identical before and after (against origin/main)..rsfiles every added or removed line is a//comment, except one blank line per removed banner (removed so rustfmt does not see two blank lines in a row).cargo buildsucceeds as before.Local results (Windows,
PYTHONUTF8=1):uvx ruff@0.17.1 checkok;ruff format --checkok (100 files).pytest -q(Python 3.15): 294 passed, 1 skipped.cargo fmt --checkok;cargo clippy --all-targets -- -D warningsok;cargo testall passed; parity run (CODIGEST_PARITY=1 cargo test --no-fail-fast -- --include-ignored) all passed.mainand change the machine, so they were not run here;readme-test.ps1 -DryRunlists them and passes. README is not changed by this PR.site/scripts/check_reference.py(docs workflow) fails with the same output on origin/main and on this branch (undocumentedcdg scanoptions inko/commands.md); not touched here.