opensearch-project/neural-search

[Code maintenance] Fix the warning messages in the build logs

Open

#1,095 opened on Jan 14, 2025

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Java (124 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (116 stars)
PR merge metrics
 (PR metrics pending)

Description

Clear the warnings from the build logs.

/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/executors/HybridQueryExecutorCollectorManager.java:10: warning: no @param for <C>
public interface HybridQueryExecutorCollectorManager<C extends HybridQueryExecutorCollector> {
       ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/executors/HybridQueryExecutorCollector.java:14: warning: no @param for <I>
public final class HybridQueryExecutorCollector<I, R> {
             ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/executors/HybridQueryExecutorCollector.java:14: warning: no @param for <R>
public final class HybridQueryExecutorCollector<I, R> {
             ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/AbstractScoreHybridizationProcessor.java:41: warning: no description for @param
     * @param <Result>
       ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/AbstractScoreHybridizationProcessor.java:20: warning: use of default constructor, which does not provide a comment
public abstract class AbstractScoreHybridizationProcessor implements SearchPhaseResultsProcessor {
                ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/ExplainableTechnique.java:22: warning: no @return
    default String describe() {
                   ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/ArithmeticMeanScoreCombinationTechnique.java:18: warning: no comment
    public static final String TECHNIQUE_NAME = "arithmetic_mean";
                               ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/ArithmeticMeanScoreCombinationTechnique.java:24: warning: no comment
    public ArithmeticMeanScoreCombinationTechnique(final Map<String, Object> params, final ScoreCombinationUtil combinationUtil) {
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/RescoringRerankProcessor.java:27: warning: no description for @param
     * @param type
       ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/RescoringRerankProcessor.java:28: warning: no description for @param
     * @param description
       ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/RescoringRerankProcessor.java:29: warning: no description for @param
     * @param tag
       ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/RescoringRerankProcessor.java:30: warning: no description for @param
     * @param ignoreFailure
       ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/RescoringRerankProcessor.java:31: warning: no description for @param
     * @param contextSourceFetchers
       ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/ByFieldRerankProcessor.java:71: warning: no comment
    public static final boolean DEFAULT_KEEP_PREVIOUS_SCORE = false;
                                ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/ByFieldRerankProcessor.java:70: warning: no comment
    public static final boolean DEFAULT_REMOVE_TARGET_FIELD = false;
                                ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/ByFieldRerankProcessor.java:69: warning: no comment
    public static final String KEEP_PREVIOUS_SCORE = "keep_previous_score";
                               ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/ByFieldRerankProcessor.java:74: warning: no comment
    protected final boolean keepPreviousScore;
                            ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/ByFieldRerankProcessor.java:68: warning: no comment
    public static final String REMOVE_TARGET_FIELD = "remove_target_field";
                               ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/ByFieldRerankProcessor.java:73: warning: no comment
    protected final boolean removeTargetField;
                            ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/ByFieldRerankProcessor.java:[67](https://github.com/opensearch-project/neural-search/actions/runs/12773657122/job/35608134601?pr=1094#step:4:68): warning: no comment
    public static final String TARGET_FIELD = "target_field";
                               ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/rerank/ByFieldRerankProcessor.java:72: warning: no comment
    protected final String targetField;
                           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/Chunker.java:46: warning: no @return
    static boolean checkRunTimeMaxChunkLimit(int chunkResultSize, int runtimeMaxChunkLimit, int chunkStringCount) {
                   ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/Chunker.java:17: warning: no comment
    String CHUNK_STRING_COUNT_FIELD = "chunk_string_count";
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/Chunker.java:18: warning: no comment
    int DEFAULT_MAX_CHUNK_LIMIT = 100;
        ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/Chunker.java:19: warning: no comment
    int DISABLED_MAX_CHUNK_LIMIT = -1;
        ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/Chunker.java:16: warning: no comment
    String MAX_CHUNK_LIMIT_FIELD = "max_chunk_limit";
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerFactory.java:28: warning: no comment
    public static Set<String> CHUNKER_ALGORITHMS = CHUNKERS_CONSTRUCTORS.keySet();
                              ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerFactory.java:30: warning: no comment
    public static Chunker create(final String type, final Map<String, Object> parameters) {
                          ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:25: warning: no @param for parameters
    public static String parseString(final Map<String, Object> parameters, final String fieldName) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:25: warning: no @param for fieldName
    public static String parseString(final Map<String, Object> parameters, final String fieldName) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:25: warning: no @return
    public static String parseString(final Map<String, Object> parameters, final String fieldName) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:43: warning: no @param for parameters
    public static String parseStringWithDefault(final Map<String, Object> parameters, final String fieldName, final String defaultValue) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:43: warning: no @param for fieldName
    public static String parseStringWithDefault(final Map<String, Object> parameters, final String fieldName, final String defaultValue) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:43: warning: no @param for defaultValue
    public static String parseStringWithDefault(final Map<String, Object> parameters, final String fieldName, final String defaultValue) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:43: warning: no @return
    public static String parseStringWithDefault(final Map<String, Object> parameters, final String fieldName, final String defaultValue) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:55: warning: no @param for parameters
    public static int parseInteger(final Map<String, Object> parameters, final String fieldName) {
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:55: warning: no @param for fieldName
    public static int parseInteger(final Map<String, Object> parameters, final String fieldName) {
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:55: warning: no @return
    public static int parseInteger(final Map<String, Object> parameters, final String fieldName) {
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:71: warning: no @param for parameters
    public static int parseIntegerWithDefault(final Map<String, Object> parameters, final String fieldName, final int defaultValue) {
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:71: warning: no @param for fieldName
    public static int parseIntegerWithDefault(final Map<String, Object> parameters, final String fieldName, final int defaultValue) {
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:71: warning: no @param for defaultValue
    public static int parseIntegerWithDefault(final Map<String, Object> parameters, final String fieldName, final int defaultValue) {
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:71: warning: no @return
    public static int parseIntegerWithDefault(final Map<String, Object> parameters, final String fieldName, final int defaultValue) {
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:84: warning: no @param for parameters
    public static int parsePositiveInteger(final Map<String, Object> parameters, final String fieldName) {
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:84: warning: no @param for fieldName
    public static int parsePositiveInteger(final Map<String, Object> parameters, final String fieldName) {
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:84: warning: no @return
    public static int parsePositiveInteger(final Map<String, Object> parameters, final String fieldName) {
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:97: warning: no @param for parameters
    public static int parsePositiveIntegerWithDefault(
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:97: warning: no @param for fieldName
    public static int parsePositiveIntegerWithDefault(
                      ^
> Task :javadoc
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:97: warning: no @param for defaultValue
    public static int parsePositiveIntegerWithDefault(
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:97: warning: no @return
    public static int parsePositiveIntegerWithDefault(
                      ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:113: warning: no @param for parameters
    public static double parseDouble(final Map<String, Object> parameters, final String fieldName) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:113: warning: no @param for fieldName
    public static double parseDouble(final Map<String, Object> parameters, final String fieldName) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:113: warning: no @return
    public static double parseDouble(final Map<String, Object> parameters, final String fieldName) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:129: warning: no @param for parameters
    public static double parseDoubleWithDefault(final Map<String, Object> parameters, final String fieldName, final double defaultValue) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:129: warning: no @param for fieldName
    public static double parseDoubleWithDefault(final Map<String, Object> parameters, final String fieldName, final double defaultValue) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:129: warning: no @param for defaultValue
    public static double parseDoubleWithDefault(final Map<String, Object> parameters, final String fieldName, final double defaultValue) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/ChunkerParameterParser.java:129: warning: no @return
    public static double parseDoubleWithDefault(final Map<String, Object> parameters, final String fieldName, final double defaultValue) {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/CombinedExplanationDetails.java:15: warning: no comment
    public static class CombinedExplanationDetailsBuilder {
                  ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/CombinedExplanationDetails.java:52: warning: no comment
    public CombinedExplanationDetails(final ExplanationDetails normalizationExplanations, final ExplanationDetails combinationExplanations) {
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/CombinedExplanationDetails.java:48: warning: no comment
    public static CombinedExplanationDetails.CombinedExplanationDetailsBuilder builder() {
                                                                               ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/CombinedExplanationDetails.java:61: warning: no comment
    public ExplanationDetails getCombinationExplanations() {
                              ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/CombinedExplanationDetails.java:57: warning: no comment
    public ExplanationDetails getNormalizationExplanations() {
                              ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/CombinedExplanationDetails.java:23: warning: no main description
         * @return {@code this}.
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/CombinedExplanationDetails.java:25: warning: no @param for normalizationExplanations
        public CombinedExplanationDetails.CombinedExplanationDetailsBuilder normalizationExplanations(final ExplanationDetails normalizationExplanations) {
                                                                            ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/CombinedExplanationDetails.java:31: warning: no main description
         * @return {@code this}.
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/CombinedExplanationDetails.java:33: warning: no @param for combinationExplanations
        public CombinedExplanationDetails.CombinedExplanationDetailsBuilder combinationExplanations(final ExplanationDetails combinationExplanations) {
                                                                            ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/CombinedExplanationDetails.java:38: warning: no comment
        public CombinedExplanationDetails build() {
                                          ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:29: warning: no comment
    public static class CombineScoresDtoBuilder {
                  ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:96: warning: no comment
    public CombineScoresDto(@NonNull final List<CompoundTopDocs> queryTopDocs, @NonNull final ScoreCombinationTechnique scoreCombinationTechnique, @NonNull final List<QuerySearchResult> querySearchResults, final Sort sort, final int fromValueForSingleShard) {
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:92: warning: no comment
    public static CombineScoresDto.CombineScoresDtoBuilder builder() {
                                                           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:126: warning: no comment
    public int getFromValueForSingleShard() {
               ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:118: warning: no comment
    public List<QuerySearchResult> getQuerySearchResults() {
                                   ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:108: warning: no comment
    public List<CompoundTopDocs> getQueryTopDocs() {
                                 ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:113: warning: no comment
    public ScoreCombinationTechnique getScoreCombinationTechnique() {
                                     ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:122: warning: no comment
    public Sort getSort() {
                ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:40: warning: no main description
         * @return {@code this}.
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:42: warning: no @param for queryTopDocs
        public CombineScoresDto.CombineScoresDtoBuilder queryTopDocs(@NonNull final List<CompoundTopDocs> queryTopDocs) {
                                                        ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:49: warning: no main description
         * @return {@code this}.
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:51: warning: no @param for scoreCombinationTechnique
        public CombineScoresDto.CombineScoresDtoBuilder scoreCombinationTechnique(@NonNull final ScoreCombinationTechnique scoreCombinationTechnique) {
                                                        ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:58: warning: no main description
         * @return {@code this}.
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:60: warning: no @param for querySearchResults
        public CombineScoresDto.CombineScoresDtoBuilder querySearchResults(@NonNull final List<QuerySearchResult> querySearchResults) {
                                                        ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:67: warning: no main description
         * @return {@code this}.
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:[69](https://github.com/opensearch-project/neural-search/actions/runs/12773657122/job/35608134601?pr=1094#step:4:70): warning: no @param for sort
        public CombineScoresDto.CombineScoresDtoBuilder sort(final Sort sort) {
                                                        ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:75: warning: no main description
         * @return {@code this}.
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:77: warning: no @param for fromValueForSingleShard
        public CombineScoresDto.CombineScoresDtoBuilder fromValueForSingleShard(final int fromValueForSingleShard) {
                                                        ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/combination/CombineScoresDto.java:82: warning: no comment
        public CombineScoresDto build() {
                                ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/CompoundTopDocs.java:66: warning: no @param for querySearchResult
    public CompoundTopDocs(final QuerySearchResult querySearchResult) {
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/CompoundTopDocs.java:31: warning: no comment
    public CompoundTopDocs(final TotalHits totalHits, final List<TopDocs> topDocs, final boolean isSortEnabled, final SearchShard searchShard) {
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/CompoundTopDocs.java:134: warning: no comment
    public CompoundTopDocs(final TotalHits totalHits, final List<TopDocs> topDocs, final List<ScoreDoc> scoreDocs, final SearchShard searchShard) {
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/CompoundTopDocs.java:149: warning: no comment
    public List<ScoreDoc> getScoreDocs() {
                          ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/CompoundTopDocs.java:166: warning: no comment
    public SearchShard getSearchShard() {
                       ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/CompoundTopDocs.java:145: warning: no comment
    public List<TopDocs> getTopDocs() {
                         ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/CompoundTopDocs.java:141: warning: no comment
    public TotalHits getTotalHits() {
                     ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/CompoundTopDocs.java:162: warning: no comment
    public void setScoreDocs(final List<ScoreDoc> scoreDocs) {
                ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/CompoundTopDocs.java:158: warning: no comment
    public void setTotalHits(final TotalHits totalHits) {
                ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/DelimiterChunker.java:19: warning: no comment
    public static final String ALGORITHM_NAME = "delimiter";
                               ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/DelimiterChunker.java:23: warning: no comment
    public static final String DEFAULT_DELIMITER = "\n\n";
                               ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/DelimiterChunker.java:21: warning: no comment
    public static final String DELIMITER_FIELD = "delimiter";
                               ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/chunker/DelimiterChunker.java:27: warning: no comment
    public DelimiterChunker(final Map<String, Object> parameters) {
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/DocIdAtSearchShard.java:17: warning: no comment
    public DocIdAtSearchShard(final int docId, final SearchShard searchShard) {
           ^
/home/runner/work/neural-search/neural-search/build/generated/sources/delombok/java/main/org/opensearch/neuralsearch/processor/explain/DocIdAtSearchShard.java:22: warning: no comment
    public int getDocId() {

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.