docs: refine comments and docstrings across codebase #423
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’ve cleaned up a number of stray and empty comment blocks throughout the core modules, removed unused commented‑out code, and tightened up the JSDoc in the error‑handling utilities. None of these edits touch logic or behavior.
Summary of changes:
run()
.parseKeyValueMap
,parseStringList
, andgetConfig
.getOpenAIClient
andgenerateCommitMessage
.runCodex
and deleted a commented‑outcore.info
debug line.genContentsString
andgenFullContentsString
.extractPromptFlags
.toErrorMessage
/toErrorStack
, removing malformed and empty blocks.loadEventPayload
andprocessEvent
.These edits restore meaningful documentation and remove clutter without altering any functionality. Please let me know if you’d like further adjustments!