k0s icon indicating copy to clipboard operation
k0s copied to clipboard

Go doc and CRD readability improvements

Open kke opened this issue 1 year ago • 8 comments

Description

Adds periods to documentation comments that will be in generated documentation / CRDs and so on.

Files are also gofumpted.

Fixes #3924

Type of change

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [X] Documentation update

How Has This Been Tested?

  • [ ] Manual test
  • [ ] Auto test added

Checklist:

  • [ ] My code follows the style guidelines of this project
  • [ ] My commit messages are signed-off
  • [ ] I have performed a self-review of my own code
  • [ ] I have commented my code, particularly in hard-to-understand areas
  • [ ] I have made corresponding changes to the documentation
  • [ ] My changes generate no new warnings
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [ ] New and existing unit tests pass locally with my changes
  • [ ] Any dependent changes have been merged and published in downstream modules
  • [ ] I have checked my code and corrected any misspellings

kke avatar Jan 16 '24 12:01 kke

Hmm, I suppose the static needs to be regenerated somehow

kke avatar Jan 16 '24 13:01 kke

The original ticket was just about making the doc strings in the OpenAPI specs easier to read. Also, there are probably some cases in which there are periods missing not only at the end, but in the middle of the comments. So more a human task than an automated one.

twz123 avatar Jan 16 '24 14:01 twz123

Go doc comments should be complete sentences too.

You could still edit the remaining problems manually after this has performed the first round of adding missing dots.

kke avatar Jan 16 '24 14:01 kke

Upon reviewing your Kubernetes CustomResourceDefinition (CRD) YAML for clusterconfigs.k0s.k0sproject.io, there were no obvious typos or missing punctuation. - ChatGPT

kke avatar Jan 17 '24 08:01 kke

This pull request has merge conflicts that need to be resolved.

github-actions[bot] avatar Feb 05 '24 19:02 github-actions[bot]

This pull request has merge conflicts that need to be resolved.

github-actions[bot] avatar Mar 01 '24 21:03 github-actions[bot]

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

github-actions[bot] avatar Mar 31 '24 23:03 github-actions[bot]

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

github-actions[bot] avatar May 02 '24 23:05 github-actions[bot]