Skip to content

Commit fc6d90c

Browse files
committed
fix typo and example rendering in .spec.version godoc
Signed-off-by: perdasilva <[email protected]>
1 parent c11ddec commit fc6d90c

File tree

2 files changed

+5
-8
lines changed

2 files changed

+5
-8
lines changed

api/v1alpha1/operator_types.go

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,9 @@ type OperatorSpec struct {
3131
//+kubebuilder:validation:MaxLength:=64
3232
//+kubebuilder:validation:Pattern=^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+([0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*))?$
3333
//+kubebuilder:Optional
34-
// Version is an optional is semver constraint on the package version. If not specified, the latest version available of the package will be installed.
34+
// Version is an optional semver constraint on the package version. If not specified, the latest version available of the package will be installed.
3535
// If specified, the specific version of the package will be installed so long as it is available in any of the content sources available.
36-
// Examples:
37-
// - 1.2.3
38-
// - 1.0.0-alpha
39-
// - 1.0.0-rc.1
36+
// Examples: 1.2.3, 1.0.0-alpha, 1.0.0-rc.1
4037
//
4138
// For more information on semver, please see https://semver.org/
4239
Version string `json:"version,omitempty"`

config/crd/bases/operators.operatorframework.io_operators.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ spec:
4040
pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
4141
type: string
4242
version:
43-
description: "Version is an optional is semver constraint on the package
43+
description: "Version is an optional semver constraint on the package
4444
version. If not specified, the latest version available of the package
4545
will be installed. If specified, the specific version of the package
4646
will be installed so long as it is available in any of the content
47-
sources available. Examples: - 1.2.3 - 1.0.0-alpha - 1.0.0-rc.1
48-
\n For more information on semver, please see https://semver.org/"
47+
sources available. Examples: 1.2.3, 1.0.0-alpha, 1.0.0-rc.1 \n For
48+
more information on semver, please see https://semver.org/"
4949
maxLength: 64
5050
pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+([0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*))?$
5151
type: string

0 commit comments

Comments
 (0)