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.

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

Updating comments to conform to golang comment specification #532

Merged
merged 1 commit into from
Jun 24, 2021

Conversation

caibirdme
Copy link
Contributor

Motivation

Go's comment spec requires that the comment must start with the name it describes. Fix some comments to reduce IDE warnings

Modifications

  • Make the comments start with the name of the element it describes

Verifying this change

  • Make sure that the change passes the CI checks.

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API: no
  • The schema: no
  • The default values of configurations: no
  • The wire protocol: no

@cckellogg
Copy link
Contributor

Is there a way to add these comments format checks to the lint checks we do for ci?

@merlimat merlimat added this to the 0.6.0 milestone Jun 24, 2021
@merlimat merlimat merged commit 641cb9d into apache:master Jun 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants