Skip to content

This PR is to add comments to GetWorkerStatefulsetName in pkg/ddc/base/runtime_conventions.go. #5884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
F-Hilbert wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −0
Open

This PR is to add comments to GetWorkerStatefulsetName in pkg/ddc/base/runtime_conventions.go. #5884

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions pkg/ddc/base/runtime_conventions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ import (
"github.com/fluid-cloudnative/fluid/pkg/common"
)

// GetWorkerStatefulsetName returns the worker StatefulSet name for the runtime.
// This function determines the name of the worker StatefulSet based on the runtime type.
// Jindo-related runtimes use the "-jindofs-worker" suffix, while other runtimes use the "-worker" suffix.
//
// Parameters:
// - None: This function does not take any parameters.
//
// Returns:
// - string: The generated worker StatefulSet name for the current runtime.
Comment on lines +7 to +15
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The documentation style using explicit Parameters and Returns sections is unidiomatic in Go. According to Go best practices (e.g., Effective Go), doc comments should be concise paragraphs where the first sentence starts with the name of the function. Redundant sections like Parameters: None should be avoided to maintain idiomatic code quality and reduce noise.

Suggested change
// GetWorkerStatefulsetName returns the worker StatefulSet name for the runtime.
// This function determines the name of the worker StatefulSet based on the runtime type.
// Jindo-related runtimes use the "-jindofs-worker" suffix, while other runtimes use the "-worker" suffix.
//
// Parameters:
// - None: This function does not take any parameters.
//
// Returns:
// - string: The generated worker StatefulSet name for the current runtime.
// GetWorkerStatefulsetName returns the worker StatefulSet name for the runtime.
// Jindo-related runtimes use the "-jindofs-worker" suffix, while other runtimes use the "-worker" suffix.
References
  1. Go doc comments should be simple sentences or paragraphs starting with the name of the declared identifier. Sections like 'Parameters' and 'Returns' are discouraged. (link)

func (info *RuntimeInfo) GetWorkerStatefulsetName() string {
switch info.runtimeType {
// JindoRuntime has a extra "-jindofs" suffix in worker statefulset name.
Expand Down
Loading