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

feat(sdk): improve cli help text #7618

Merged

Conversation

connor-mccarthy
Copy link
Member

@connor-mccarthy connor-mccarthy commented Apr 26, 2022

Description of your changes:
Makes several improvements to the KFP CLI help text, including:

  • Programatically retrieving option help text from docstrings.
  • Making command descriptions more consistent.
  • Cleaning up existing docstrings.

This PR also adds basic smoke tests for each command group of the CLI to ensure they
run and retrieve help text correctly.

Checklist:

@google-oss-prow
Copy link

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@connor-mccarthy
Copy link
Member Author

/test all

@connor-mccarthy
Copy link
Member Author

/test all

1 similar comment
@connor-mccarthy
Copy link
Member Author

/test all

@connor-mccarthy connor-mccarthy marked this pull request as ready for review April 26, 2022 20:54
@connor-mccarthy
Copy link
Member Author

/test all

@connor-mccarthy
Copy link
Member Author

/hold Merge after #7606

@connor-mccarthy
Copy link
Member Author

/unhold

@connor-mccarthy
Copy link
Member Author

/retest

Copy link
Member

@chensun chensun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

Thanks!

@google-oss-prow
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chensun

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

@google-oss-prow google-oss-prow bot merged commit ec00813 into kubeflow:master Apr 29, 2022
jagadeeshi2i pushed a commit to jagadeeshi2i/pipelines that referenced this pull request May 11, 2022
* add docstring parsing utils

* implement docstring parsing for help text

* implement smoke test of all cli commands

* clean up use of optional in docstring

* make command descriptions more consistent

* fix disable_type_check

* update release notes
abaland pushed a commit to abaland/pipelines that referenced this pull request May 29, 2022
* add docstring parsing utils

* implement docstring parsing for help text

* implement smoke test of all cli commands

* clean up use of optional in docstring

* make command descriptions more consistent

* fix disable_type_check

* update release notes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants