[Go Docs] Update Documentation #60
Merged
Conversation
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
- [+] refactor(helper.go): improve function and parameter descriptions in getParamAsString, getParamAsInt64, getParamAsInt, and logTaskStart functions
- [+] 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
- [+] 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
- [+] refactor(captain.go): update function signature and add parameter descriptions - [+] chore(captain.go): remove unused imports
- [+] 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
- [+] chore(labels_pods.go): fix formatting and add missing parameter descriptions in function comments
- [+] docs(list_options.go): update function signature and add parameter description
- [+] docs(list_pods.go): update function signature and parameter descriptions for listPods function
- [+] chore(worker): update function signatures and add comments for clarity - [+] refactor(worker): rename variables for better readability
- [+] docs(pvc_storage.go): update function signature and parameter descriptions for createPVC function
- [+] refactor(scale.go): improve comments and parameter names for ScaleDeployment and scaleDeploymentOnce functions - [+] chore(scale.go): fix formatting and indentation in int32Ptr function
- [+] refactor(worker): update comments in setup.go - [+] The comments in the `setup.go` file have been updated to provide more clarity and consistency.
- [+] 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
- [+] 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
- [+] docs(update_image.go): update function signature and parameter descriptions in UpdateDeploymentImage function
- [+] 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
- [+] 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.