Repository navigation
Code quality: readable names, docs, type hints, ruff, CI - #42
Merged
Merged
Conversation
… mia_data Rename one-letter and cryptic variables (self.s -> self.state, p -> pr, cw/vw -> crop_workspace/verify_workspace, _c -> safe_text, ...), add type hints for Config/GitHub/Mirror/jobs/client parameters via TYPE_CHECKING imports, and replace spec-reference comments with short descriptions of what each module, class and non-obvious method does. JobArgs fields ws/n/crop_ws become workspace/n_crops/crop_workspace (activity inputs, not replayed). VerifyResult.n keeps its name because it is an activity result present in recorded Temporal histories. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
ruff joins the test feature with E/F/W/I/UP/B rules at line length 120. Fixes: sorted imports, typing imports from collections.abc, datetime.UTC, PEP 695 type parameters for the permanent_errors decorators, explicit zip strictness, and in tests a mutable default argument, a loop-variable closure, blind exception asserts and `l` variable names. requires-python moves to 3.12, which the pixi environment already pins and the code already relies on (nested f-string quotes). Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
`pixi run fmt` formats and autofixes, `pixi run lint` fails on drift. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Re-applies PR #40 on the renamed, formatted code: issue_lead in the PR body, free-form catalog label keys, and the snippet issue wording. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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
1 participant
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.
Summary
autodev/andmia_data/: one-letter and cryptic names replaced (self.s→self.state,p→pr,cw/vw→crop_workspace/verify_workspace,_c→safe_text, ...), type hints on object parameters (Config,GitHub,Mirror, job clients, TemporalClient) viaTYPE_CHECKINGimports, and spec-reference comments replaced with plain-language descriptions of each module, class and non-obvious method.JobArgsfields were renamed (ws/n/crop_ws→workspace/n_crops/crop_workspace) since activity inputs are not replayed.VerifyResult.nkeeps its name because it is an activity result present in recorded Temporal histories and in-flight workflows.pixi run lint,pixi run fmt): E/F/W/I/UP/B rules at line length 120, plusruff formatapplied repo-wide in its own commit. Fixes it prompted: sorted imports,collections.abcimports,datetime.UTC, PEP 695 type parameters, explicitzipstrictness, and in tests a mutable default argument, a loop-variable closure, blindExceptionasserts andlvariables.requires-pythonmoves to 3.12 (pixi already pins it andseed.pyuses 3.12 f-string syntax)..gitignorecovers all localautodev*.yamlconfigs.Review tip: the format commit (
8a432e8) is whitespace only; view the others individually.Test plan
pixi run lintcleanpixi run test: 324 passed, including replay tests against recorded histories🤖 Generated with Claude Code