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.

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

Merged
merged 1 commit into from Jan 7, 2022

Conversation

invincibleJai
Copy link
Member

Fixes:

https://issues.redhat.com/browse/HAC-391

Description:

  • adds/updates jsdoc comments
  • expose useK8sWatchResource(s) hooks from SDK
  • adds typing

@openshift-ci openshift-ci bot added component/sdk Related to console-plugin-sdk approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 5, 2022
@andrewballantyne
Copy link
Contributor

/assign

export const k8sListResource: K8sListResource = adapterFunc(k8sList, [
'model',
'queryParams',
'raw',
Copy link
Contributor

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

Copy link
Member Author

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.

#10243 (comment)

image

Copy link
Contributor

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.

Copy link
Contributor

@andrewballantyne andrewballantyne left a 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',
Copy link
Contributor

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.

@andrewballantyne
Copy link
Contributor

No customer-facing documentation needed, this is all internal to the SDK.
/label docs-approved
/label px-approved

No QE needed, this is a documentation update PR.
/label qe-approved

(just in case my previous approval doesn't add this)
/lgtm

/retest

@openshift-ci openshift-ci bot added docs-approved Signifies that Docs has signed off on this PR px-approved Signifies that Product Support has signed off on this PR qe-approved Signifies that QE has signed off on this PR lgtm Indicates that a PR is ready to be merged. labels Jan 6, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jan 6, 2022

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

3 similar comments
@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jan 7, 2022

@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.

@openshift-merge-robot openshift-merge-robot merged commit 7f86628 into openshift:master Jan 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. component/sdk Related to console-plugin-sdk docs-approved Signifies that Docs has signed off on this PR lgtm Indicates that a PR is ready to be merged. px-approved Signifies that Product Support has signed off on this PR qe-approved Signifies that QE has signed off on this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants