fix: export BasePool interface for correct godoc rendering#143
Merged
Conversation
The private basePool interface embedded in Pool and ResultPool causes go doc to omit all base methods from the generated documentation. Export it as BasePool so the full API surface is visible on pkg.go.dev. Fixes alitto#141
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #143 +/- ##
=======================================
Coverage 95.74% 95.74%
=======================================
Files 11 11
Lines 611 611
=======================================
Hits 585 585
Misses 23 23
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
alitto
approved these changes
Apr 14, 2026
Owner
alitto
left a comment
alitto
left a comment
There was a problem hiding this comment.
LGTM. Thanks for sending this PR!
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.
Fixes #141
Problem
The private
basePoolinterface is embedded in bothPoolandResultPool[R]. Due to a known Go doc limitation, methods from embedded private interfaces are omitted from the generated documentation on pkg.go.dev.This means essential methods like
RunningWorkers(),Stop(),StopAndWait(), etc. are invisible in the docs.Fix
Rename
basePool→BasePool(exported). This is a minor API addition (new exported type), not a breaking change — existing code embeddingPoolorResultPoolcontinues to work.Testing
All existing tests pass.