cleanup: resolve godot linter #2256
Conversation
e2e/rbd.go
Outdated
| @@ -56,7 +56,7 @@ var ( | |||
| ) | |||
|
|
|||
| func deployRBDPlugin() { | |||
| // delete objects deployed by rook | |||
| // delete objects deployed by rook. | |||
There was a problem hiding this comment.
I think the comments-should-end-with-a-dot is only required for top-level comments, not inside functions? Could you check that please?
There was a problem hiding this comment.
Yes sure @nixpanic . I will check and update accordingly.
|
@nixpanic godot linter checks only for top-level comments. I have made the necessary changes, but we don't follow a particular format for comments throughout the code. Hence, I suggest we should have some guidelines that can bring uniformity to the code. |
internal/rbd/driver.go
Outdated
| @@ -124,7 +124,7 @@ func (r *Driver) Run(conf *util.Config) { | |||
| volJournal = journal.NewCSIVolumeJournal(CSIInstanceID) | |||
| snapJournal = journal.NewCSISnapshotJournal(CSIInstanceID) | |||
|
|
|||
| // Initialize default library driver | |||
| // Initialize default library drivers | |||
There was a problem hiding this comment.
Did godot give a warning here? If not, I think this change can be reverted.
There was a problem hiding this comment.
Hey, that's my mistake. Maybe added that while saving the file. will correct that. Thanks for notifying me.
I think following the godot guidelines is sufficient. Comments inside functions are much more important to me than the formatting of them. The godot guidelines make sense for APIs that are re-used, and make documentation like https://pkg.go.dev/github.com/ceph/ceph-csi helpful for new contributors. |
|
/retest ci/centos/mini-e2e-helm/k8s-1.21 |
|
/retest ci/centos/mini-e2e-helm/k8s-1.21 |
mergify
bot
dismissed stale reviews from Madhu-1 and nixpanic
Pull request has been modified.
nixpanic
added
ci/skip/e2e
|
This pull request now has conflicts with the target branch. Could you please resolve conflicts and force push the corrected changes? 🙏 |
|
oh, sorry, #2270 introduced a conflict with this PR 😞 |
No worries will resolve it. Facing network issues currently. |
This commit resolves godot linter issue which says "Comment should end in a period (godot)". Updates: ceph#1586 Signed-off-by: Yati Padia <ypadia@redhat.com>
This commit resolves godot linter issue
which says "Comment should end in a period (godot)".
Updates: #1586
Signed-off-by: Yati Padia ypadia@redhat.com