docs(consumer): add javadoc @param/@return on CB + EntryMetricsReporter (recovery follow-up)#114
Merged
Merged
Conversation
Recovers the doc fixes from the original PR #105 / #106 follow-up commits that got dropped during the recovery PR's cherry-pick chain (rebase saw them as 'already applied' relative to the rebase point, but they hadn't actually reached main). Adds: - CircuitBreakerController: constructor doc, @param/@return on shouldTrip and shouldProbe - EntryMetricsReporter: @param/@return on all four factory methods (forProcessors/forSinks, with and without keys) and toConsumer No code changes. `./gradlew :lib:kpipe-consumer:javadoc` is now clean (was 18 warnings).
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #114 +/- ##
============================================
+ Coverage 70.22% 70.57% +0.35%
- Complexity 589 591 +2
============================================
Files 63 63
Lines 2344 2345 +1
Branches 301 301
============================================
+ Hits 1646 1655 +9
+ Misses 556 544 -12
- Partials 142 146 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
1 participant
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.
Summary
The doc-fix commits I made on the original PR #105 / #106 layered branches got dropped during the recovery PR's cherry-pick chain — git's "already applied" detection saw them as redundant relative to the rebase point, but they hadn't actually reached main. CI confirmed by reporting 18 javadoc warnings on
kpipe-consumerafter #113 merged.This PR restores those doc fixes directly against main:
CircuitBreakerController— constructor doc,@param/@returnonshouldTripandshouldProbe.EntryMetricsReporter—@param/@returnon all four factories (forProcessors,forProcessors(_, keys),forSinks,forSinks(_, keys)) andtoConsumer.No code changes.
./gradlew javadocnow clean across all 10 modules.Test plan
./gradlew :lib:kpipe-consumer:javadoc --rerun-tasksclean./gradlew javadocclean (full codebase)