[Backport] [2.x] New javadoc and improvement of existing javadoc (#10064) #10563
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
reta
requested review from
anasalkouz,
andrross,
Bukhtawar,
CEHENKLE,
dblock,
gbbafna,
setiah,
kartg,
kotwanikunal,
mch2,
nknize,
owaiskazi19,
peternied,
Rishikesh1159,
ryanbogan,
saratvemulapalli,
shwetathareja,
dreamer-89,
VachaShah,
dbwiddis,
sachinpkale,
sohami and
msfroh
as code owners
Compatibility status:Checks if related components are compatible with change 4158a52 Incompatible componentsSkipped componentsCompatible componentsCompatible components: [https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/performance-analyzer.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/neural-search.git] |
…0064) * Fixing javadoc error fixing javadoc error and warning javadoc for org.opensearch.core.indices.breaker javadoc for org.opensearch.core.index.shard.ShardId javadoc for org.opensearch.core.index.Index fixing a mishap in formatting rule fixing javadoc of org.opensearch.cli.Terminal Signed-off-by: Laurent Laborde <[email protected]> * removing unsupported @ImplNote Signed-off-by: Laurent Laborde <[email protected]> * Update libs/common/src/main/java/org/opensearch/common/collect/Iterators.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Update libs/compress/src/main/java/org/opensearch/compress/ZstdCompressor.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Apply suggestions from code review Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Apply suggestions from code review Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Apply suggestions from code review Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Apply suggestions from code review Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Update CollectionUtils.java Signed-off-by: Laurent Laborde <[email protected]> * fixing javadoc warnings Signed-off-by: Laurent Laborde <[email protected]> * remove useless p tag Signed-off-by: Laurent Laborde <[email protected]> * removing a p tag Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * proper capitalization Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * improvements of existing javadocs Signed-off-by: Laurent Laborde <[email protected]> * javadoc improvement Signed-off-by: Laurent Laborde <[email protected]> * javadoc improvement Signed-off-by: Laurent Laborde <[email protected]> * Fix formatting error after merge conflict resolution in a javadoc Signed-off-by: Laurent Laborde <[email protected]> * "code" tag ignore carriage return & "p", switching to a "pre" tag Signed-off-by: Laurent Laborde <[email protected]> * fixing an overzealous precommit check error. Signed-off-by: Laurent Laborde <[email protected]> * Update distribution/tools/launchers/src/main/java/org/opensearch/tools/launchers/SystemJvmOptions.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Update server/src/internalClusterTest/java/org/opensearch/search/sort/GeoDistanceSortBuilderIT.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Update server/src/main/java/org/opensearch/action/admin/cluster/repositories/get/GetRepositoriesRequest.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Update server/src/main/java/org/opensearch/action/admin/cluster/snapshots/create/CreateSnapshotRequest.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Update server/src/main/java/org/opensearch/action/admin/indices/replication/SegmentReplicationStatsRequest.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Update server/src/main/java/org/opensearch/cluster/RestoreInProgress.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Update test/framework/src/main/java/org/opensearch/test/AbstractDiffableWireSerializationTestCase.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * Update test/framework/src/main/java/org/opensearch/test/AbstractDiffableSerializationTestCase.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * further improvement of javadoc after review & suggestions Signed-off-by: Laurent Laborde <[email protected]> * fixing unreferenced @link in javadoc (precommit error) Signed-off-by: Laurent Laborde <[email protected]> * removing p tag from internal comment Signed-off-by: Laurent Laborde <[email protected]> * reverting javadoc tag in licence header Signed-off-by: Laurent Laborde <[email protected]> * Update server/src/main/java/org/opensearch/search/aggregations/metrics/AbstractPercentilesAggregationBuilder.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Laurent Laborde <[email protected]> * conflict resolution Signed-off-by: Laurent Laborde <[email protected]> --------- Signed-off-by: Laurent Laborde <[email protected]> Co-authored-by: Andriy Redko <[email protected]> (cherry picked from commit c0852f8) Signed-off-by: Andriy Redko <[email protected]>
reta
force-pushed
the
backport/backport-10064-to-2.x
branch
from
655312d to
4158a52
Compare
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Codecov Report
@@ Coverage Diff @@
## 2.x #10563 +/- ##
============================================
+ Coverage 70.83% 70.89% +0.06%
- Complexity 58509 58521 +12
============================================
Files 4830 4830
Lines 276386 276386
Branches 40580 40580
============================================
+ Hits 195788 195956 +168
+ Misses 63877 63692 -185
- Partials 16721 16738 +17
|
|
@dblock @kotwanikunal mind please approving folks, large backport :) |
kotwanikunal
approved these changes
Oct 11, 2023
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.
Backport of #10064 to
2.x