refactor: improve code readability and update comments #424
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.
Closes #365
Applied changes based on Issue #365.
I made focused, non‑breaking tweaks to clean up unused comments and tighten up our inline documentation without altering any logic:
1. Remove commented‐out debug logging in the Codex runner
Removed an obsolete
core.info
line that was commented out in src/client/codex.ts—it served no purpose and only cluttered the code.【F:src/client/codex.ts†L125-L130】
2. Clean up redundant JSDoc stubs and improve section headers in GitHub helper
In src/github/github.ts, there were a number of empty “@param” JSDoc stubs left over (with no descriptions) before
getBranchType
andslugify
, plus non‐descriptive section marker comments. I removed the useless stubs and replaced the “---” markers with concise, descriptive comments:【F:src/github/github.ts†L29-L59】【F:src/github/github.ts†L82-L91】【F:src/github/github.ts†L189-L195】
These tweaks remove dead/commented‐out code and tidy up our inline docs, boosting readability and consistency while leaving all functionality untouched. Let me know if you’d like further refinements!