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

Reopen mterm descriptions PR for editorial. #648

Merged
merged 3 commits into from
Oct 25, 2024

Conversation

Naarcha-AWS
Copy link
Contributor

Description

Describe what this change achieves.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

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.

Copy link
Contributor

github-actions bot commented Oct 25, 2024

Changes Analysis

Commit SHA: 95bcb91
Comparing To SHA: 86e4789

API Changes

Summary

└─┬Components
  ├─┬_core.rank_eval:RankEvalMetricExpectedReciprocalRank
  │ └─┬ALLOF
  │   └─┬maximum_relevance
  │     └──[🔀] description (41757:28)
  ├─┬_core.rank_eval:RankEvalMetricBase
  │ └─┬k
  │   └──[🔀] description (41713:24)
  ├─┬_core.rank_eval:RankEvalMetricDetail
  │ ├─┬hits
  │ │ └──[🔀] description (41727:24)
  │ ├─┬unrated_docs
  │ │ └──[🔀] description (41722:24)
  │ └─┬metric_details
  │   └──[🔀] description (41732:24)
  ├─┬_core.rank_eval:RankEvalMetricPrecision
  │ └─┬ALLOF
  │   └─┬ignore_unlabeled
  │     └──[🔀] description (41771:28)
  └─┬_core.rank_eval:RankEvalMetricDiscountedCumulativeGain
    ├─┬ALLOF
    │ └──[🔀] $ref (41746:11)❌ 
    └─┬ALLOF
      └──[🔀] $ref (41710:13)❌ 

Document Element Total Changes Breaking Changes
components 8 4
  • BREAKING Changes: 4 out of 8
  • Modifications: 8
  • Breaking Modifications: 2

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11521480264/artifacts/2105008127

API Coverage

Before After Δ
Covered (%) 588 (57.59 %) 588 (57.59 %) 0 (0 %)
Uncovered (%) 433 (42.41 %) 433 (42.41 %) 0 (0 %)
Unknown 30 30 0

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
505 320 (63.37 %)

Copy link
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!

spec/schemas/_core.mtermvectors.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.rank_eval.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.rank_eval.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.rank_eval.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.rank_eval.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.rank_eval.yaml Outdated Show resolved Hide resolved
spec/schemas/_core.rank_eval.yaml Show resolved Hide resolved
Naarcha-AWS and others added 2 commits October 25, 2024 10:54
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Archer <[email protected]>
@Naarcha-AWS
Copy link
Contributor Author

@natebower: Feedback implemented. Let me know if I missed anything.

@dblock dblock added the skip-changelog No need to update CHANGELOG. label Oct 25, 2024
Copy link
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Naarcha-AWS LGTM!

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I merge?

@natebower
Copy link
Contributor

Can I merge?

@dblock I'm assuming you should be good to go. Thanks!

@dblock dblock merged commit 931a61a into opensearch-project:main Oct 25, 2024
21 of 31 checks passed
@Naarcha-AWS Naarcha-AWS changed the title Reopen mtern descriptions PR for editorial. Reopen mterm descriptions PR for editorial. Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No need to update CHANGELOG.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants