examples: improve package comments

[eshitachandwani]

Updated the comments in various example files to provide clearer and more detailed descriptions and to make the code easier to understand for users who are reading through the examples.

Changes:

• Enhanced comments to better explain the functionality and flow of the examples.
• Added context where necessary to clarify the use of specific gRPC features.
• Improved formatting and consistency in comment styles.

RELEASE NOTES: none

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.00%. Comparing base (8ea3460) to head (d97740d).
Report is 12 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #7658      +/-   ##
==========================================
+ Coverage   81.86%   82.00%   +0.14%     
==========================================
  Files         361      361              
  Lines       27821    27822       +1     
==========================================
+ Hits        22775    22815      +40     
+ Misses       3847     3825      -22     
+ Partials     1199     1182      -17     

see 35 files with indirect coverage changes

[purnesh42H]

I think its not clear how compressor is supported. Perhaps we can try to be a little bit more clear how support happens. may be at line 30?

// Importing the gzip encoding registers it as an available compressor.
// gRPC will automatically negotiate and use gzip if the client supports it.

[eshitachandwani]

Done

[easwars]

I think the current trailing comment on line 30 is clear enough and is more appropriate for a blank import compared to the comment added by this change.

A statement like // gRPC will automatically negotiate and use gzip if the client supports it. feels more appropriate in the README file.

[purnesh42H]

oh I meant to modify the package comment to something like Binary server demonstrates importing the gzip encoding to register it as an available compressor

I remember an issue some time back where user was confused how to enable compression even after providing the link to example until I mentioned to them importing is all we need to do and rest is taken care by grpc

[easwars]

Maybe, we should improve the documentation somewhere (either in the example, or in Documentation/compression.md or in the gzip package) then?

[easwars]

I think the current trailing comment on line 30 is clear enough and is more appropriate for a blank import compared to the comment added by this change.

A statement like // gRPC will automatically negotiate and use gzip if the client supports it. feels more appropriate in the README file.