-
Notifications
You must be signed in to change notification settings - Fork 630
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
chore(simple_object_merger): update README #6146
chore(simple_object_merger): update README #6146
Conversation
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Signed-off-by: scepter914 <scepter914@gmail.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6146 +/- ##
=======================================
Coverage 14.60% 14.60%
=======================================
Files 1860 1860
Lines 127418 127418
Branches 37286 37286
=======================================
Hits 18609 18609
Misses 87902 87902
Partials 20907 20907
*This pull request uses carry forward flags. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with a bullet-point format for explanations.
Even though, we might need to add/keep auto-generated table of parameters from JSON Schema .
* chore(simple_object_merger): update README Signed-off-by: scepter914 <scepter914@gmail.com> * style(pre-commit): autofix * update README Signed-off-by: scepter914 <scepter914@gmail.com> * style(pre-commit): autofix * update README Signed-off-by: scepter914 <scepter914@gmail.com> --------- Signed-off-by: scepter914 <scepter914@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Description
This PR update for the document of
simple_object_merger
.It mainly to add document for tuning parameters and the table style made it hard to read, so this PR changed it to bullet points.
Tests performed
No need
Effects on system behavior
No effect
Pre-review checklist for the PR author
The PR author must check the checkboxes below when creating the PR.
In-review checklist for the PR reviewers
The PR reviewers must check the checkboxes below before approval.
Post-review checklist for the PR author
The PR author must check the checkboxes below before merging.
After all checkboxes are checked, anyone who has write access can merge the PR.