-
Notifications
You must be signed in to change notification settings - Fork 59
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
Update bindings.md with 'x_k8s_get()' example #1915
Conversation
Thanks @jlucktay ! I think we should create a dedicated page with jp functions examples. |
Yes, of course, we can split it up and rearrange however you see fit. I just wanted to capture some working samples for this functionality, because I think it's yet another example of how powerful Chainsaw can be. 💪 |
Added a commented example on how to bind other objects with the 'x_k8s_get()' function, then refer and assert against. Signed-off-by: James Lucktaylor <jlucktay@users.noreply.github.com>
Signed-off-by: James Lucktaylor <jlucktay+github@gmail.com>
@eddycharly I moved the code sample to its own page, and pointed a couple of links there. Is that structure OK? |
@jlucktay you can't really do that in the functions reference docs, it is a generated page. Can I push in your PR ? |
Sure, please go ahead. |
Ok, let's do that, thanks! |
Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
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.
Thanks @jlucktay for initiating this change !
/cherry-pick release-0.2 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1915 +/- ##
=======================================
Coverage 70.00% 70.00%
=======================================
Files 134 134
Lines 5500 5500
=======================================
Hits 3850 3850
Misses 1335 1335
Partials 315 315 ☔ View full report in Codecov by Sentry. |
* Update bindings.md with 'x_k8s_get()' example Added a commented example on how to bind other objects with the 'x_k8s_get()' function, then refer and assert against. Signed-off-by: James Lucktaylor <jlucktay@users.noreply.github.com> * docs: move x_k8s_get example to its own page Signed-off-by: James Lucktaylor <jlucktay+github@gmail.com> * restructure Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com> --------- Signed-off-by: James Lucktaylor <jlucktay@users.noreply.github.com> Signed-off-by: James Lucktaylor <jlucktay+github@gmail.com> Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com> Co-authored-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
* Update bindings.md with 'x_k8s_get()' example Added a commented example on how to bind other objects with the 'x_k8s_get()' function, then refer and assert against. * docs: move x_k8s_get example to its own page * restructure --------- Signed-off-by: James Lucktaylor <jlucktay@users.noreply.github.com> Signed-off-by: James Lucktaylor <jlucktay+github@gmail.com> Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com> Co-authored-by: James Lucktaylor <jlucktay@users.noreply.github.com> Co-authored-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
Explanation
Added a commented example on how to bind other objects with the
x_k8s_get()
function, then refer and assert against.Related issue
Resolves #1897.
Proposed Changes
Documentation only, with an example test and contextual comments.
Checklist
Further Comments
There is currently no documentation anywhere that I could find to describe how the
x_k8s_get()
function behaves, or what inputs it would take.