docs(mathx): add godoc comment to Numerical type constraint#5470
Merged
kevwan merged 1 commit intozeromicro:masterfrom Mar 21, 2026
Merged
docs(mathx): add godoc comment to Numerical type constraint#5470kevwan merged 1 commit intozeromicro:masterfrom
kevwan merged 1 commit intozeromicro:masterfrom
Conversation
kevwan
reviewed
Mar 21, 2026
Contributor
kevwan
left a comment
There was a problem hiding this comment.
LGTM — adds a clear, accurate godoc comment to the exported Numerical constraint. The description "permits any numeric type" is correct given the full union of ~int, ~int8 … ~float32, ~float64, and ~complex64, ~complex128 variants.
kevwan
approved these changes
Mar 21, 2026
48d0993 to
b9074d1
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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.
Problem
The
Numericaltype constraint incore/mathx/range.gois the only exported type in the go-zerocore/packages without a godoc comment. Every other exported type, function, and variable follows the Go convention of having a documentation comment.Solution
Added a standard godoc comment:
Impact
go docoutput and IDE hover documentationTesting performed
Files changed
core/mathx/range.go— added 1 comment line