*: function comments revamp #4048
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates function comments across the codebase to improve clarity and accuracy. The changes correct function comment names to match their actual function names, fix typos, and ensure comments accurately describe what each function does.
Key changes:
- Updated function comments to match actual function names (e.g.,
reportMetrics,isQUICEnabled) - Corrected mismatched comment descriptions to reflect the correct function purpose
- Fixed comment positioning relative to nolint directives
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| testutil/promrated/promrated.go | Capitalized comment to follow Go convention for exported-style comments |
| p2p/p2p.go | Fixed capitalization to match unexported function name |
| core/ssz.go | Updated comment to accurately describe validator index marshaling |
| core/priority/component.go | Corrected comment name from "Proposal" to "Result" |
| cmd/createcluster.go | Moved nolint directive after function comment per Go conventions |
| cluster/ssz.go | Fixed two function comment names to match actual function names |
| cluster/manifest/helpers.go | Corrected comment name from "to0xHex" to "from0xHex" |
| cluster/helpers.go | Fixed two function comment names to accurately reflect function purposes |
| app/sse/listener.go | Added function name to comment following Go documentation conventions |
| app/peerinfo/peerinfo.go | Corrected comment to match actual function name |
| app/obolapi/exit_model.go | Fixed comment name from "putByteList" to "putBytesN" |
| app/eth2wrap/version.go | Fixed capitalization to match unexported function name |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4048 +/- ##
==========================================
+ Coverage 53.80% 53.86% +0.06%
==========================================
Files 242 242
Lines 39425 39425
==========================================
+ Hits 21214 21238 +24
+ Misses 15967 15950 -17
+ Partials 2244 2237 -7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
DiogoSantoss
approved these changes
Oct 22, 2025
KaloyanTanev
approved these changes
Oct 23, 2025
pinebit
added
the
merge when ready
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
global function comments revamp with claude.
category: refactor
ticket: none