-
Notifications
You must be signed in to change notification settings - Fork 605
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
adds/updates jsdoc comments, expose useK8sWatchResource(s) hooks from SDK and adds typing #10779
Conversation
/assign |
frontend/packages/console-dynamic-plugin-sdk/src/utils/k8s/k8s-resource.ts
Outdated
Show resolved
Hide resolved
export const k8sListResource: K8sListResource = adapterFunc(k8sList, [ | ||
'model', | ||
'queryParams', | ||
'raw', |
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.
Still a little odd that you're not specifying raw
in the JSDoc
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.
yeah, this is not being used across so in initial PR the thought was not to expose it in a new signature.
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.
My only concern is that this is something that is almost self documented in a very limited way due to the signature of the adapterFunc
and thus looks like a gap in the JSDoc. But given Sam believes there is only 1 impacted location, I suppose we could look to move away from it... not sure how we deprecate a single param though.
… SDK andadds typing
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.
Looking good, thanks for fixing up and closing this gap @invincibleJai
My only follow up point here is I'm still not comfortable with the way the adapterFunc
signature looks in respect to the way JSDoc -- but that's a discussion we have already have had and I guess this will be okay for now.
export const k8sListResource: K8sListResource = adapterFunc(k8sList, [ | ||
'model', | ||
'queryParams', | ||
'raw', |
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.
My only concern is that this is something that is almost self documented in a very limited way due to the signature of the adapterFunc
and thus looks like a gap in the JSDoc. But given Sam believes there is only 1 impacted location, I suppose we could look to move away from it... not sure how we deprecate a single param though.
No customer-facing documentation needed, this is all internal to the SDK. No QE needed, this is a documentation update PR. (just in case my previous approval doesn't add this) /retest |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: andrewballantyne, invincibleJai The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/retest-required Please review the full test history for this PR and help us cut down flakes. |
3 similar comments
/retest-required Please review the full test history for this PR and help us cut down flakes. |
/retest-required Please review the full test history for this PR and help us cut down flakes. |
/retest-required Please review the full test history for this PR and help us cut down flakes. |
@invincibleJai: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
Fixes:
https://issues.redhat.com/browse/HAC-391
Description: