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

🌱 Fixes typo in machine types description #4487

Merged
merged 1 commit into from
Apr 16, 2021
+1 −1
Merged

🌱 Fixes typo in machine types description #4487

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
2 changes: 1 addition & 1 deletion api/v1alpha4/machine_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you need to run make generate to actually update the description in config/

Copy link
Member

Choose a reason for hiding this comment

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

Uhmm this should be captured by verify scripts...

Copy link
Member

Choose a reason for hiding this comment

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

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.

type Bootstrap struct {
// ConfigRef is a reference to a bootstrap provider-specific resource
// that holds configuration details. The reference is optional to
Expand Down