Append Kdoc for ShadowJar and minor cleanups
#1368
Merged
+98
−9
Conversation
This file contains 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
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
Files not reviewed (3)
- src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/JavaPluginTest.kt: Language not supported
- src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/RelocationTest.kt: Language not supported
- src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowJar.kt: Language not supported
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
The pull request adds KDoc to the ShadowJar class and performs some minor cleanups. The added documentation enhances the readability and understandability of the code. The changes look good overall.
Summary of Findings
- Missing KDoc for public methods: Some public methods in the
ShadowJarclass are missing KDoc. Adding KDoc to these methods would improve the overall documentation of the class. I was instructed not to add review comments for this issue due to the review settings. - Inconsistent default values documentation: The documentation for
relocationPrefixproperty defaults toshadowwhile the actual default value isShadowBasePlugin.SHADOW. This inconsistency should be fixed. I was instructed not to add review comments for this issue due to the review settings. - Redundant comments: Some comments are redundant and do not add any value to the code. These comments should be removed to improve the code's readability. I was instructed not to add review comments for this issue due to the review settings.
Merge Readiness
The pull request is almost ready for merging. The added KDoc improves the code's documentation. However, there are a few minor issues that should be addressed before merging. Specifically, the documentation for relocationPrefix property should be updated to reflect the actual default value. I am unable to approve this pull request, and recommend that others review and approve this code before merging.
src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/RelocationTest.kt
Show resolved
Hide resolved
Goooler
force-pushed
the
g/20250325/improve-tests
branch
from
7007a1d to
f0dabe2
Compare
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.
No description provided.