RUM-11737: Add documentation to the public API members where missing#2880
Merged
0xnm merged 1 commit intoSep 16, 2025
Merged
Conversation
0xnm
force-pushed
the
nogorodnikov/rum-11737/add-documentation-to-public-api-where-missing
branch
from
September 15, 2025 16:01
55fec93 to
09b13ff
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2880 +/- ##
===========================================
+ Coverage 70.58% 70.59% +0.01%
===========================================
Files 810 810
Lines 29666 29666
Branches 5079 5079
===========================================
+ Hits 20938 20940 +2
+ Misses 7297 7294 -3
- Partials 1431 1432 +1
🚀 New features to boost your workflow:
|
aleksandr-gringauz
approved these changes
Sep 16, 2025
0xnm
deleted the
nogorodnikov/rum-11737/add-documentation-to-public-api-where-missing
branch
September 16, 2025 14:52
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
3 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.
What does this PR do?
With Detekt version change from
1.23.4(the one we are using on CI) to1.23.8we have new reports for the Public API check and we need to address them. Mostly it is missing documentation for the enum members.Note: there are also reports about missing docs for
companion objectclasses, but this should either be ignored or it is a but in the Detekt rule.Review checklist (to be filled by reviewers)