This PR is to add comments to WithMetadataList in pkg/ddc/base/runtime.go.#5959
This PR is to add comments to WithMetadataList in pkg/ddc/base/runtime.go.#5959flippyside wants to merge 1 commit into
Conversation
Signed-off-by: Akosus <144044633+flippyside@users.noreply.github.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hi @flippyside. Thanks for your PR. I'm waiting for a fluid-cloudnative member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds GoDoc documentation to the WithMetadataList function in pkg/ddc/base/runtime.go. The review feedback recommends removing an extra blank line that violates standard gofmt formatting, as well as removing a redundant inline comment that simply restates the code's behavior.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
|
||
|
|
||
| // WithMetadataList returns a RuntimeInfoOption that sets the metadataList field | ||
| // on a RuntimeInfo instance. | ||
| // | ||
| // Parameters: | ||
| // - metadataList: a slice of Metadata objects to associate with the RuntimeInfo. | ||
| // | ||
| // Returns: | ||
| // - A RuntimeInfoOption function that, when applied, assigns the provided | ||
| // metadataList to info.metadataList and returns nil (no error). | ||
| func WithMetadataList(metadataList []datav1alpha1.Metadata) RuntimeInfoOption { | ||
| return func(info *RuntimeInfo) error { | ||
| // Assign the provided metadataList to the RuntimeInfo instance. | ||
| info.metadataList = metadataList | ||
| return nil | ||
| } |
There was a problem hiding this comment.
There are two minor issues in this change:
- An extra empty line was introduced before the function documentation, which violates standard
gofmtformatting (which collapses multiple empty lines). - The inline comment
// Assign the provided metadataList to the RuntimeInfo instance.is redundant as it merely restates what the code does.
We can clean this up by removing the extra empty line and the redundant inline comment.
// WithMetadataList returns a RuntimeInfoOption that sets the metadataList field
// on a RuntimeInfo instance.
//
// Parameters:
// - metadataList: a slice of Metadata objects to associate with the RuntimeInfo.
//
// Returns:
// - A RuntimeInfoOption function that, when applied, assigns the provided
// metadataList to info.metadataList and returns nil (no error).
func WithMetadataList(metadataList []datav1alpha1.Metadata) RuntimeInfoOption {
return func(info *RuntimeInfo) error {
info.metadataList = metadataList
return nil
}
}
|
flippyside
changed the title
1 participant
I. Describe what this PR does
Add Notation to WithMetadataList in pkg/ddc/base/runtime.go
II. Does this pull request fix one issue?
fixes #5958
III. Special notes for reviews