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.

Sign up for GitHub

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

Jump to bottom

adding documentation on files in util in addition to a README.md with an overview of each file and its exported functions #5540

Merged
merged 2 commits into from
Dec 14, 2023
Merged

adding documentation on files in util in addition to a README.md with an overview of each file and its exported functions #5540

merged 2 commits into from
Dec 14, 2023

Conversation

tanupa
Copy link
Contributor

@tanupa tanupa commented Nov 27, 2023 •
edited by ananzh
Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@tanupa
adding documentation on files in util in addition to a README.md with…
147a3e2 
… an overview of each file and its exported functions

Signed-off-by: tanupa <tanupa01@gmail.com>
@codecov Codecov
Copy link

codecov bot commented Nov 29, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5fabb73) 66.97% compared to head (eafb458) 66.95%.
Report is 7 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #5540      +/-   ##
==========================================
- Coverage   66.97%   66.95%   -0.02%     
==========================================
  Files        3293     3293              
  Lines       63289    63289              
  Branches    10065    10065              
==========================================
- Hits        42390    42378      -12     
- Misses      18458    18469      +11     
- Partials     2441     2442       +1
Flag Coverage Δ
Linux_1 35.24% <ø> (ø)
Linux_2 55.17% <ø> (ø)
Linux_3 43.78% <ø> (-0.02%) ⬇️
Linux_4 35.34% <ø> (ø)
Windows_1 ?
Windows_2 55.14% <ø> (ø)
Windows_3 43.80% <ø> (ø)
Windows_4 35.34% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ananzh ananzh changed the title adding documentation on files in util in addition to a README.md with… adding documentation on files in util in addition to a README.md with an overview of each file and its exported functions Dec 12, 2023
@joshuarrrr joshuarrrr assigned BSFishy and kavilla and unassigned joshuarrrr Dec 13, 2023
@joshuarrrr
Copy link
Member

Thanks @tanupa , this is an awesome contribution. Can you add an entry to the CHANGELOG file under the Documentation section?

Assigned to @BSFishy and @kavilla to review, as they built out this package and are most familiar to validate the accuracy of the docs.

kavilla
kavilla approved these changes Dec 13, 2023
View reviewed changes
Copy link
Member

@kavilla kavilla left a comment

Choose a reason for hiding this comment

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

Thank you so much!

@kavilla
Copy link
Member

kavilla commented Dec 13, 2023

@joshuarrrr we should consider executing some doc generator to see what we get.

@kavilla kavilla added the docs Improvements or additions to documentation label Dec 13, 2023
@ananzh ananzh added the v2.12.0 label Dec 13, 2023
BSFishy
BSFishy approved these changes Dec 14, 2023
View reviewed changes
Copy link
Contributor

@BSFishy BSFishy left a comment

Choose a reason for hiding this comment

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

LGTM

@ananzh ananzh added the Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry label Dec 14, 2023
@ananzh ananzh merged commit 4d57b8a into opensearch-project:main Dec 14, 2023
75 of 81 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 14, 2023
@github-actions @joshuarrrr
adding documentation on files in util in addition to a README.md with…
5b32118 
… an overview of each file and its exported functions (#5540)

Signed-off-by: tanupa <tanupa01@gmail.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
(cherry picked from commit 4d57b8a)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Dec 14, 2023
Merged
manasvinibs pushed a commit that referenced this pull request Dec 18, 2023
@opensearch-trigger-bot @github-actions @joshuarrrr
adding documentation on files in util in addition to a README.md with…
44f53fc 
… an overview of each file and its exported functions (#5540) (#5618)

(cherry picked from commit 4d57b8a)

Signed-off-by: tanupa <tanupa01@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Josh Romero <rmerqg@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BSFishy BSFishy BSFishy approved these changes

@kavilla kavilla kavilla approved these changes

@ananzh ananzh Awaiting requested review from ananzh ananzh is a code owner

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@ashwin-pc ashwin-pc Awaiting requested review from ashwin-pc ashwin-pc is a code owner

@joshuarrrr joshuarrrr Awaiting requested review from joshuarrrr joshuarrrr is a code owner

@abbyhu2000 abbyhu2000 Awaiting requested review from abbyhu2000 abbyhu2000 is a code owner

@zengyan-amazon zengyan-amazon Awaiting requested review from zengyan-amazon zengyan-amazon is a code owner

@kristenTian kristenTian Awaiting requested review from kristenTian

@zhongnansu zhongnansu Awaiting requested review from zhongnansu zhongnansu is a code owner

@manasvinibs manasvinibs Awaiting requested review from manasvinibs manasvinibs is a code owner

@ZilongX ZilongX Awaiting requested review from ZilongX ZilongX is a code owner

@Flyingliuhub Flyingliuhub Awaiting requested review from Flyingliuhub Flyingliuhub is a code owner

@curq curq Awaiting requested review from curq curq is a code owner

@bandinib-amzn bandinib-amzn Awaiting requested review from bandinib-amzn bandinib-amzn is a code owner

@SuZhou-Joe SuZhou-Joe Awaiting requested review from SuZhou-Joe SuZhou-Joe is a code owner

Assignees

@BSFishy BSFishy

@kavilla kavilla

Labels
backport 2.x docs Improvements or additions to documentation first-time-contributor Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry v2.12.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@tanupa @joshuarrrr @kavilla @BSFishy @ananzh