This PR is to add comments to BuildRuntimeInfo in pkg/ddc/base/runtime.go#5854
This PR is to add comments to BuildRuntimeInfo in pkg/ddc/base/runtime.go#5854lhxian wants to merge 1 commit into
Conversation
|
[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 @lhxian. 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 documentation for the BuildRuntimeInfo function in pkg/ddc/base/runtime.go. The feedback suggests updating the documentation examples for runtimeType to use constants like common.AlluxioRuntime instead of capitalized strings to ensure consistency with the actual values used throughout the codebase.
| // Parameters: | ||
| // - name (string): The name of the runtime. | ||
| // - namespace (string): The namespace of the runtime. | ||
| // - runtimeType (string): The type of the runtime (e.g., Alluxio, JuiceFS). |
There was a problem hiding this comment.
The examples provided for runtimeType ('Alluxio', 'JuiceFS') use capitalized names, which might be misleading as the actual runtime type strings in Fluid are typically lowercase (e.g., 'alluxio', 'juicefs') and are defined as constants in the common package. It is recommended to reference these constants directly (e.g., common.AlluxioRuntime) to ensure correctness and consistency with other documentation in this file (see line 619).
| // - runtimeType (string): The type of the runtime (e.g., Alluxio, JuiceFS). | |
| // - runtimeType (string): The type of the runtime (e.g., common.AlluxioRuntime, common.JuiceFSRuntime). |
|
🤖 DCO check failed for this PR. Please ensure all commits include the You can fix this by running: git commit --amend --signoffor for all commits: git rebase --signoff HEAD~N |
Signed-off-by: Hanxian Lao <1687483153@qq.com>
|
2 participants
Ⅰ. Describe what this PR does
Add comments to BuildRuntimeInfo in pkg/ddc/base/runtime.go
Ⅱ. Does this pull request fix one issue?
fixes #[5853]
lll. Special notes for reviews