adding documentation on files in util in addition to a README.md with an overview of each file and its exported functions #5540
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
… an overview of each file and its exported functions Signed-off-by: tanupa <[email protected]>
tanupa
requested review from
ananzh,
kavilla,
AMoo-Miki,
ashwin-pc,
joshuarrrr,
abbyhu2000,
zengyan-amazon,
kristenTian,
zhongnansu,
manasvinibs,
ZilongX,
Flyingliuhub,
BSFishy and
curq
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
ananzh
changed the title
|
@joshuarrrr we should consider executing some doc generator to see what we get. |
ananzh
added
the
Skip-Changelog
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Dec 14, 2023
… an overview of each file and its exported functions (#5540) Signed-off-by: tanupa <[email protected]> Co-authored-by: Josh Romero <[email protected]> (cherry picked from commit 4d57b8a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
manasvinibs
pushed a commit
that referenced
this pull request
Dec 18, 2023
… an overview of each file and its exported functions (#5540) (#5618) (cherry picked from commit 4d57b8a) Signed-off-by: tanupa <[email protected]> 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 <[email protected]>
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.
Description
Issues Resolved
Screenshot
Testing the changes
Check List
yarn test:jestyarn test:jest_integration