docs: correct mismatched godoc comment names#6976
Open
eeshsaxena wants to merge 1 commit into
Open
Conversation
Several exported functions had doc comments that began with a different function's name (Go convention is the doc comment starts with the name of the thing it documents): - GetGrpcClientConnection: comment said GetConnection - TriggerCiCron: comment said UpdateCiWorkflowStatusFailedCron - CreateOrUpdateAppOrEnvLevelMetrics: comment said CheckAndUpdateAppOrEnvLevelMetrics - Int63nRange: comment said IntnRange
eeshsaxena
requested review from
prakarsh-dt,
vikramdevtron and
vivek-devtron
as code owners
|
Bito Review Skipped - Source Branch Not Found |
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
A few exported functions had doc comments that began with a different function's name (Go convention is that a doc comment starts with the name of the symbol it documents). These look like copy/paste leftovers from renamed functions:
GetGrpcClientConnection(client/argocdServer/connection): comment saidGetConnectionTriggerCiCron(client/cron): comment saidUpdateCiWorkflowStatusFailedCronCreateOrUpdateAppOrEnvLevelMetrics(pkg/deployment/manifest/deployedAppMetrics): comment saidCheckAndUpdateAppOrEnvLevelMetricsInt63nRange(util): comment saidIntnRangeComment-only change; no behavior change.