[chore] Add doc comments to exported internal symbols (4/N) - #8926
Open
om7057 wants to merge 1 commit into
Open
Conversation
om7057
requested review from
MrAlias,
XSAM,
dashpole,
dmathieu,
flc1125 and
pellared
as code owners
September 4, 2026 15:13
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8926 +/- ##
=====================================
Coverage 88.5% 88.5%
=====================================
Files 331 331
Lines 21013 21013
=====================================
Hits 18602 18602
Misses 2411 2411
🚀 New features to boost your workflow:
|
Continues the internal-package doc comment cleanup started in open-telemetry#8752, open-telemetry#8762, and open-telemetry#8869, this time covering the root module: attribute/internal/xxhash, internal/errorhandler, and semconv/internal/{v2,v3,v4}/net.go. This clears the last remaining violations in the root module.
om7057
force-pushed
the
doc-comments-internal-root-semconv-xxhash-errorhandler
branch
from
September 4, 2026 15:17
9e0b8d4 to
5c0170d
Compare
dmathieu
approved these changes
Sep 7, 2026
3 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Continuation of #8752, #8762, and #8869, the fourth scoped slice toward eventually removing the internal-packages exclusion on the
reviveexportedrule in.golangci.yml.This clears every remaining violation in the root module (
go.opentelemetry.io/otel):semconv/internal/{v2,v3,v4}/net.go:NetConv.Transport,NetConv.HostName,NetConv.HostPort,NetConv.PeerName,NetConv.PeerPort,NetConv.SockPeerAddr,NetConv.SockPeerPort(7 each). These three files are byte-identical copies across semconv versions, so I applied the same wording to all three and verified withdiffthat they remain identical afterward.attribute/internal/xxhash/xxhash.go:Hash.Uint64,Hash.Float64,Hash.Int64.Hash.BoolandHash.Stringin the same file aren't flagged by the linter (the former has an explicitnolint:revive), so I left those alone to keep the diff to only what's required.internal/errorhandler/errorhandler.go: theErrDelegatortype and itsHandlemethod.Test plan
go build ./...,go vet ./...,go test ./...pass for the root module.golangci-lint run(pinnedinternal/toolsversion) returns 0 issues for the whole root module, including with the internal-packages exclusion temporarily removed.No
CHANGELOG.mdentry, comment-only change with no behavior impact.