Skip to content

.*: fix revive package-comments lint issues #7574

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

Merged

Conversation

purnesh42H
Copy link
Contributor

@purnesh42H purnesh42H commented Aug 30, 2024

Addresses: #7444

RELEASE NOTES: None

Copy link

codecov bot commented Aug 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.87%. Comparing base (845f62c) to head (5c25ba6).
Report is 4 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7574      +/-   ##
==========================================
+ Coverage   81.76%   81.87%   +0.11%     
==========================================
  Files         361      361              
  Lines       27825    27809      -16     
==========================================
+ Hits        22752    22770      +18     
+ Misses       3866     3847      -19     
+ Partials     1207     1192      -15     

see 23 files with indirect coverage changes

@purnesh42H purnesh42H self-assigned this Aug 30, 2024
@purnesh42H purnesh42H added the Type: Documentation Documentation or examples label Aug 30, 2024
@purnesh42H purnesh42H added this to the 1.67 Release milestone Aug 30, 2024
@purnesh42H purnesh42H assigned arvindbr8 and dfawley and unassigned purnesh42H Aug 30, 2024
@purnesh42H purnesh42H mentioned this pull request Aug 30, 2024
13 tasks
@@ -16,6 +16,7 @@
*
*/

// Binary client is an example client.
Copy link
Member

Choose a reason for hiding this comment

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

Can you include the example's purpose/name here too? E.g.

// Binary client is an example client for CSM observability.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added. Should we change other examples as well? I just followed the other examples and they didn't have names

Copy link
Member

Choose a reason for hiding this comment

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

The goal is not to increase the scope of this work. I'm fine with leaving existing things alone -- unless you want to go change them, in which case I will approve.

In general, though, we should never use "some other thing we have does X" as an excuse to do "X", if we know "X" is not optimal.

Copy link
Contributor Author

@purnesh42H purnesh42H Sep 2, 2024

Choose a reason for hiding this comment

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

I agree. I was just not sure if it was intentional to leave out the names.

@arvindbr8 arvindbr8 assigned purnesh42H and unassigned arvindbr8 and dfawley Aug 30, 2024
@purnesh42H purnesh42H force-pushed the fix-revive-package-comments-lints branch from 150705e to 8829742 Compare August 30, 2024 18:37
@purnesh42H purnesh42H force-pushed the fix-revive-package-comments-lints branch from 8829742 to acb5a77 Compare August 30, 2024 18:37
@purnesh42H purnesh42H requested a review from dfawley August 30, 2024 18:39
@purnesh42H purnesh42H assigned dfawley and unassigned purnesh42H Aug 30, 2024
Copy link
Member

@dfawley dfawley left a comment

Choose a reason for hiding this comment

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

One small nit, otherwise LGTM. Thanks!

@@ -16,6 +16,7 @@
*
*/

// Binary client is an example client for custom load balancer.
Copy link
Member

Choose a reason for hiding this comment

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

This is not proper English. "for a custom load balancer" or "a client for the custom load balancer example", etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks. Done

@dfawley dfawley assigned purnesh42H and unassigned dfawley Aug 30, 2024
@purnesh42H purnesh42H merged commit cd05c9e into grpc:master Sep 3, 2024
14 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Type: Documentation Documentation or examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants