Skip to content
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

[BUG] Invalid javadoc in PaginationStrategy class prevents OpenSearch compiling with javadocs #16374

Open
dbwiddis opened this issue Oct 18, 2024 · 0 comments
Labels
bug Something isn't working Other untriaged

Comments

@dbwiddis
Copy link
Member

dbwiddis commented Oct 18, 2024

Describe the bug

The PaginationStrategy class has javadoc errors using @param inline in three places:

* Utility method to get list of indices filtered as per {@param filterPredicate} and the sorted according to {@param comparator}.

* Utility method to get list of indices sorted as per {@param comparator}.

These prevent a Gradle compile task from completing successfully without warning-mode disabled.

Related component

Other

To Reproduce

  1. In a GitHub action, Checkout OpenSearch and assemble.
  2. Observe compile failure
/home/runner/work/opensearch-sdk-py/opensearch-sdk-py/opensearch/server/src/main/java/org/opensearch/action/pagination/PaginationStrategy.java:48: error: no tag name after @
     * Utility method to get list of indices filtered as per {@param filterPredicate} and the sorted according to {@param comparator}.
                                                             ^
/home/runner/work/opensearch-sdk-py/opensearch-sdk-py/opensearch/server/src/main/java/org/opensearch/action/pagination/PaginationStrategy.java:48: error: no tag name after @
     * Utility method to get list of indices filtered as per {@param filterPredicate} and the sorted according to {@param comparator}.
                                                                                                                  ^
/home/runner/work/opensearch-sdk-py/opensearch-sdk-py/opensearch/server/src/main/java/org/opensearch/action/pagination/PaginationStrategy.java:60: error: no tag name after @
     * Utility method to get list of indices sorted as per {@param comparator}.
                                                           ^

...

FAILURE: Build completed with 2 failures.
> Task :server:compileJava FAILED

110 actionable tasks: 110 executed
1: Task failed with an exception.
-----------
* What went wrong:
Execution failed for task ':server:compileJava'.
> Compilation failed; see the compiler error output for details.

Expected behavior

OpenSearch compiles without javadoc errors.

Additional Details

Additional context

This does not appear on OpenSearch because these javadoc errors are suppressed in gradle.properties:

org.gradle.warning.mode=none

However, this configuration is not used in other project GHA. It can be worked around by using --warning-mode none switch on gradle commands, but it's better to not require projects to ignore these errors to compile.

Bug introduced in #14641

CC: @gargharsh3134 @shwetathareja @rajiv-kv @vikasvb90

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Other untriaged
Projects
None yet
Development

No branches or pull requests

1 participant