-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Go Docs] Update Documentation (#60)
* Go Docs [Worker] [Helper Function] Fix Formatting - [+] refactor(helper.go): improve function and parameter descriptions in getParamAsString, getParamAsInt64, getParamAsInt, and logTaskStart functions * Go Docs [Worker] [Helper Function] Update Documentation - [+] refactor(helper.go): improve comments and function names for clarity and consistency - [+] feat(helper.go): add logErrorWithFields function to log errors with additional context - [+] feat(helper.go): add logResultsFromChannel function to log messages received from a channel * Go Docs [Worker] [Crew] Fix Formatting - [+] feat(crew.go): add function signatures and parameter descriptions for CrewWorker, processTask, handleFailedTask, handleSuccessfulTask, performTaskWithRetries, and CrewProcessPods functions - [+] fix(crew.go): fix parameter type for handleFailedTask function - [+] fix(crew.go): fix parameter type for performTaskWithRetries function - [+] fix(crew.go): fix parameter type for CrewProcessPods function - [+] fix(crew.go): fix return type for performTaskWithRetries function - [+] fix(crew.go): fix return type for CrewCheckingisPodHealthy function * Go Docs [Worker] [Captain] Fix Formatting - [+] refactor(captain.go): update function signature and add parameter descriptions - [+] chore(captain.go): remove unused imports * Go Docs [Worker] [Error and Retry] Fix Formatting - [+] chore(worker/error_and_retry.go): refactor function signatures and add parameter descriptions - [+] feat(worker/error_and_retry.go): add logRetryAttempt function to log retry attempts - [+] feat(worker/error_and_retry.go): add logFinalError function to log final error - [+] feat(worker/error_and_retry.go): add handleTaskError function to handle task errors - [+] feat(worker/error_and_retry.go): add handleConflictError function to handle conflict errors - [+] feat(worker/error_and_retry.go): add handleGenericError function to handle generic errors * Go Docs [Worker] [Labels Pods] Fix Formatting - [+] chore(labels_pods.go): fix formatting and add missing parameter descriptions in function comments * Go Docs [Worker] [List Options] Fix Formatting - [+] docs(list_options.go): update function signature and add parameter description * Go Docs [Worker] [List Pods] Fix Formatting - [+] docs(list_pods.go): update function signature and parameter descriptions for listPods function * Go Docs [Worker] [Logs Pods] Fix Formatting - [+] chore(worker): update function signatures and add comments for clarity - [+] refactor(worker): rename variables for better readability * Go Docs [Worker] [PVC Storage] Fix Formatting - [+] docs(pvc_storage.go): update function signature and parameter descriptions for createPVC function * Go Docs [Worker] [Scale Deployment] Fix Formatting - [+] refactor(scale.go): improve comments and parameter names for ScaleDeployment and scaleDeploymentOnce functions - [+] chore(scale.go): fix formatting and indentation in int32Ptr function * Go Docs [Worker] [Setup K8S] Fix Formatting - [+] refactor(worker): update comments in setup.go - [+] The comments in the `setup.go` file have been updated to provide more clarity and consistency. * Go Docs [Worker] [Task Crew] Fix Missing Docs - [+] feat(tasks_crew.go): add InitializeTasks function to load tasks from configuration file - [+] feat(tasks_crew.go): add extractScaleParameters function to extract scaling parameters from task - [+] feat(tasks_crew.go): add performScaling function to carry out scaling operation for Kubernetes deployment * Go Docs [Worker] [Track Task] Fix Formatting - [+] chore(track_task.go): update comments and formatting in TaskStatusMap struct and methods - [+] chore(track_task.go): remove deadcode comments and update parameter comments in TaskStatusMap methods * Go Docs [Worker] [Update Image Deployments] Fix Formatting - [+] docs(update_image.go): update function signature and parameter descriptions in UpdateDeploymentImage function * Go Docs [Worker] [Update Network Policy] Fix Formatting - [+] chore(worker): update function signatures and add parameter descriptions in update_network_policy.go - [+] chore(worker): update function signature and add parameter description in unmarshalPolicySpec function * Go Docs [Worker] [Configuration [Task] Fix Missing Docs - [+] fix(task.go): add comments explaining unmarshalJSON and unmarshalYAML functions - [+] fix(task.go): add comments explaining parseTasks function - [+] fix(task.go): add comments explaining ParseDuration function
- Loading branch information
1 parent
3c98ee2
commit 39f0c22
Showing
16 changed files
with
319 additions
and
206 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.