Skip to content

Improve naming consistencies in comments in snapshotter.go#7032

Merged
kzys merged 1 commit intocontainerd:mainfrom
swagatbora90:snapshotter-naming-comments
Jun 10, 2022
Merged

Improve naming consistencies in comments in snapshotter.go#7032
kzys merged 1 commit intocontainerd:mainfrom
swagatbora90:snapshotter-naming-comments

Conversation

@swagatbora90
Copy link
Copy Markdown
Contributor

Signed-off-by: Swagat Bora [email protected]

  • Fix inconsistencies in snapshotter.go comments to use uppercase in all places for the Snapshotter
  • Fix some typos

@k8s-ci-robot
Copy link
Copy Markdown

Hi @swagatbora90. Thanks for your PR.

I'm waiting for a containerd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Copy link
Copy Markdown
Member

@samuelkarp samuelkarp left a comment

Choose a reason for hiding this comment

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

Is there a particular reason you preferred upper-case for consistency rather than lower-case?

Comment thread snapshots/snapshotter.go Outdated
Comment thread snapshots/snapshotter.go Outdated
@swagatbora90
Copy link
Copy Markdown
Contributor Author

Is there a particular reason you preferred upper-case for consistency rather than lower-case?

Mostly because majority of the existing comments are using upper-case and the usage seemed similar to how we refer a proper noun.

@samuelkarp
Copy link
Copy Markdown
Member

Mostly because majority of the existing comments are using upper-case and the usage seemed similar to how we refer a proper noun.

Makes sense. My bias would be lower-case, but we don't have a style guide so this is fine too. (Since you're at Amazon: you can check around with the doc writers there but the AWS style guide generally prefers lower-case for object names.)

Your fixup commit is causing CI to fail since it does not have a proper DCO signature. Mind squashing the commits together and making sure you retain the Signed-off-by line so that the CI workflow can continue?

@swagatbora90 swagatbora90 force-pushed the snapshotter-naming-comments branch from c4ccc27 to 02b85b9 Compare June 8, 2022 21:29
@swagatbora90
Copy link
Copy Markdown
Contributor Author

Makes sense. My bias would be lower-case, but we don't have a style guide so this is fine too. (Since you're at Amazon: you can check around with the doc writers there but the AWS style guide generally prefers lower-case for object names.)

Thanks for the review. I have not seen any such style guide myself, but I will look around. Perhaps it will have some good justification around the using lower case.

Copy link
Copy Markdown
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

prefer moving to and / or sticking with the lowercase, in this case

@swagatbora90 swagatbora90 force-pushed the snapshotter-naming-comments branch from 02b85b9 to 61690d7 Compare June 9, 2022 17:16
@swagatbora90
Copy link
Copy Markdown
Contributor Author

prefer moving to and / or sticking with the lowercase, in this case

Sure, I have changed to use lower-case, since there is a clear preference now. PTAL.

@kzys kzys merged commit d6518b6 into containerd:main Jun 10, 2022
@swagatbora90 swagatbora90 deleted the snapshotter-naming-comments branch June 10, 2022 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants