-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix Javadoc errors in module client/rest
#685
Fix Javadoc errors in module client/rest
#685
Conversation
Signed-off-by: Gregor Zurowski <[email protected]>
Signed-off-by: Gregor Zurowski <[email protected]>
✅ Gradle Wrapper Validation success 9bbb5c9 |
✅ DCO Check Passed 9bbb5c9 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gzurowski Thanks for the contribution. I have approved it with a few minor comments :)
client/rest/src/main/java/org/opensearch/client/HasAttributeNodeSelector.java
Outdated
Show resolved
Hide resolved
client/rest/src/main/java/org/opensearch/client/HeapBufferedAsyncResponseConsumer.java
Show resolved
Hide resolved
client/rest/src/main/java/org/opensearch/client/RestClient.java
Outdated
Show resolved
Hide resolved
client/rest/src/main/java/org/opensearch/client/WarningFailureException.java
Outdated
Show resolved
Hide resolved
Signed-off-by: Gregor Zurowski <[email protected]>
Signed-off-by: Gregor Zurowski <[email protected]>
✅ DCO Check Passed 514433e |
✅ Gradle Wrapper Validation success 514433e |
@adnapibar Thanks for your review, I've made the suggested updates. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great @gzurowski . It fixes all 64 errors due to missing javadocs in client:rest
module, which is pretty awesome! - https://gist.github.com/setiah/8c6805822a790bd3536a23ea75d25b29
PS: Validatied by running ./gradlew client:rest:missingJavadoc
Noticed it was merged into the |
Yes this was intentional but I agree this needs to go in
|
This is the second time I've seen this precommit failure:
We shouldn't get into a habit of merging w/ failing precommit. Is this a CI config issue? Red herring? |
@nknize the precommit fails because of #449 . That's why we are keeping these changes in separate feature (javadoc) branch, until we fix that. Good news though, I have figured a fix for #449 , and once that's merged, the precommit should start passing and then we can merge javadoc branch to main |
* Adds a gradle plugin to validate missing javadocs Use `./gradlew missingJavadoc` to validate missing javadocs. Currently this task fails because several modules are missing appropriate javadocs. Once added, this should pass. Also, precommit PomValidation check currently fails with missing Javadoc plugin, that needs to be fixed - #449 Thus keeping this in a separate feature branch. Signed-off-by: Himanshu Setia <[email protected]> * Fix Javadoc errors in module `client/rest` (#685) * Fix Javadoc errors in client/rest module Signed-off-by: Gregor Zurowski <[email protected]> * Add package info file in client/rest module Signed-off-by: Gregor Zurowski <[email protected]> * Fix typos Signed-off-by: Gregor Zurowski <[email protected]> * Add exception documentation to Javadoc Signed-off-by: Gregor Zurowski <[email protected]> * Fixes precommit task configuration failures due to newly added missin… (#707) * Fixes precommit task configuration failures due to newly added missingJavadoc task Signed-off-by: Himanshu Setia <[email protected]> * Fixes javadoc task errors due to PR#685 Signed-off-by: Himanshu Setia <[email protected]> * Updated CONTRIBUTING.md for info on javadocs Signed-off-by: Himanshu Setia <[email protected]> * Correcting licenses and naming Signed-off-by: Himanshu Setia <[email protected]> * Correcting version info Signed-off-by: Himanshu Setia <[email protected]> Co-authored-by: Gregor Zurowski <[email protected]>
Description
Fix Javadoc comments to fix Javadoc errors as described in issue #221.
Issues Resolved
Fixes Javadoc errors in the
client/rest
module.Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.