🌱 Fixes typo in machine types description #4487
Conversation
Signed-off-by: Sagar Muchhal <[email protected]>
k8s-ci-robot
added
cncf-cla: yes
| @@ -210,7 +210,7 @@ func (m *MachineStatus) GetTypedPhase() MachinePhase { | |||
|
|
|||
| // ANCHOR: Bootstrap | |||
|
|
|||
| // Bootstrap capsulates fields to configure the Machine’s bootstrapping mechanism. | |||
| // Bootstrap encapsulates fields to configure the Machine’s bootstrapping mechanism. | |||
There was a problem hiding this comment.
I think you need to run make generate to actually update the description in config/
There was a problem hiding this comment.
Uhmm this should be captured by verify scripts...
There was a problem hiding this comment.
I don't think the struct comment is actually used anywhere, the description of the field (when using a struct as a pointer or not) is derived from the comment on that field, not the one on the linked struct.
Tested the verify script locally and it's still working properly.
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: CecileRobertMichon The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
What this PR does / why we need it:
nit: Fixes a typo in comment
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):n/a