Skip to content

Fix: Correct typo docstring and use of present tense in config.go #529

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
Steven-Yiran wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −4
Open

Fix: Correct typo docstring and use of present tense in config.go #529

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
8 changes: 4 additions & 4 deletions pkg/envconf/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import (
"sigs.k8s.io/e2e-framework/pkg/flags"
)

// Config represents and environment configuration
// Config represents the environment configuration
type Config struct {
client klient.Client
kubeconfig string
Expand Down Expand Up @@ -100,7 +100,7 @@ func (c *Config) KubeconfigFile() string {
return c.kubeconfig
}

// WithClient used to update the environment klient.Client
// WithClient updates the environment klient.Client
func (c *Config) WithClient(client klient.Client) *Config {
c.client = client
return c
Expand All @@ -112,7 +112,7 @@ func (c *Config) GetClient() klient.Client {
}

// NewClient is a constructor function that returns a previously
// created klient.Client or create a new one based on configuration
// created klient.Client or creates a new one based on configuration
// previously set. Will return an error if unable to do so.
func (c *Config) NewClient() (klient.Client, error) {
if c.client != nil {
Expand Down Expand Up @@ -258,7 +258,7 @@ func (c *Config) WithFailFast() *Config {
return c
}

// FailFast indicate if the framework is running in fail fast mode. This
// FailFast indicates if the framework is running in fail fast mode. This
// controls the behavior of how the assessments and features are handled
// if a test encounters a failure result
func (c *Config) FailFast() bool {
Expand Down