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

Jump to bottom

Use real sentences for comments kube-builder "managed" objects #3924

Closed
jnummelin opened this issue Jan 12, 2024 · 2 comments
Closed

Use real sentences for comments kube-builder "managed" objects #3924

jnummelin opened this issue Jan 12, 2024 · 2 comments
Assignees
@kke
Labels
chore Stale

Comments

@jnummelin
Copy link
Member

The comments are copied over to OpenAPI/CRD spec but that does not take in the line breaks, see #3902 (comment). We should use real sentences, with punctuation so the field comments in CRDs/OpenAPI will be more readable.
@jnummelin jnummelin mentioned this issue Jan 12, 2024
Merged
16 tasks
@kke kke self-assigned this Jan 16, 2024
@kke
Copy link
Contributor

kke commented Jan 16, 2024

I'll take a stab at writing a quick go/ast / go/parser script for this.

@kke kke mentioned this issue Jan 16, 2024
Closed
16 tasks
@github-actions GitHub Actions
Copy link
Contributor

The issue is marked as stale since no activity has been recorded in 30 days

@github-actions github-actions bot added the Stale label Feb 15, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kke kke

Labels
chore Stale
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Go doc and CRD readability improvements k0sproject/k0s
2 participants
@kke @jnummelin