Skip to content
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

🌱 add better description to MarshalYAML and UnmarshalYAML methods #4438

Merged
merged 1 commit into from
Dec 25, 2024
Merged

🌱 add better description to MarshalYAML and UnmarshalYAML methods #4438

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
4 changes: 2 additions & 2 deletions pkg/config/interface.go
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

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

A suggestion is to enable linter to avoid this in the future

The rule for checking this is currently disabled

kubebuilder/.golangci.yml

Lines 37 to 38 in 49ad403

- name: exported
disabled: true # TODO: Investigate if it should be enabled. Disabled for now due to many findings.

We could check this by adding this param and updating golangci-lint version

      - name: exported
        arguments:
          - "checkPublicInterface"

Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ type Config interface {

/* Persistence */

// Marshal returns the YAML representation of the Config.
// MarshalYAML Marshal returns the YAML representation of the Config.
MarshalYAML() ([]byte, error)
// Unmarshal loads the Config fields from its YAML representation.
// UnmarshalYAML Unmarshal loads the Config fields from its YAML representation.
UnmarshalYAML([]byte) error
}
Loading