Skip to content

Commit

Permalink
markers: improved godoc for NewMarkerFor
Browse files Browse the repository at this point in the history
  • Loading branch information
beatrausch committed Jul 1, 2024
1 parent 7378db1 commit 291718e
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions pkg/machinery/marker.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,14 @@ type Marker struct {
value string
}

// NewMarkerFor creates a new marker customized for the specific file
// Supported file extensions: .go, .yaml, .yml
// NewMarkerFor creates a new marker customized for the specific file. The created marker
// is prefixed with `+kubebuilder:scaffold:` the default prefix for kubebuilder.
// Supported file extensions: .go, .yaml, .yml.
func NewMarkerFor(path string, value string) Marker {
return NewMarkerWithPrefixFor(kbPrefix, path, value)
}

// NewMarkerWithPrefixFor creates a new prefixed marker customized for the specific file
// NewMarkerWithPrefixFor creates a new custom prefixed marker customized for the specific file
// Supported file extensions: .go, .yaml, .yml
func NewMarkerWithPrefixFor(prefix string, path string, value string) Marker {
ext := filepath.Ext(path)
Expand Down

0 comments on commit 291718e

Please sign in to comment.