[Sweep Rules] Add Docstrings and Comments

[sweep-ai[bot]]

PR Feedback (click)

• [ ] 👍 Sweep Did Well
• [ ] 👎 Sweep Needs Improvement

  I created this PR to address this rule:

  "All docstrings and comments should be up to date"

  Description

  This PR adds docstrings and comments to improve code readability and maintainability in the following files:

• src/pipeline/transaction/helpers.ts
• src/pipeline/transaction/runTQLMutation.ts
• src/pipeline/transaction/runTQLQuery.ts

The changes include adding docstrings to each function to describe their purpose, input parameters, return values, and any exceptions that may be raised. Additionally, comments have been added throughout the code to provide further explanation of the functionality.

Summary of Changes

• Added a docstring to the getSessionOrOpenNewOne function in src/pipeline/transaction/helpers.ts to explain its purpose, input parameters, return values, and exceptions.
• Added a docstring to the runTQLMutation function in src/pipeline/transaction/runTQLMutation.ts to explain its purpose, input parameters, return values, and exceptions. Comments were also added throughout the function.
• Added a docstring to the runTQLQuery function in src/pipeline/transaction/runTQLQuery.ts to explain its purpose, input parameters, return values, and exceptions. Comments were also added throughout the function.

Please review and merge these changes to improve the codebase's documentation and maintainability.

[sweep-ai[bot]]

Rollback Files For Sweep

• [ ] Rollback changes to src/pipeline/transaction/helpers.ts
• [ ] Rollback changes to src/pipeline/transaction/runTQLMutation.ts
• [ ] Rollback changes to src/pipeline/transaction/runTQLQuery.ts

[sweep-ai[bot]]

Sandbox Executions