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

[Serve] Fix serve run help message #37859

Merged
merged 1 commit into from
Jul 27, 2023

Conversation

GeneDer
Copy link
Contributor

@GeneDer GeneDer commented Jul 27, 2023

Why are these changes needed?

Re: #35754 We previously added -h help command to the serve cli's click group. This caused the autogenerated help message to take -h as the default help command. For serve run we have a collusion on -h as it's used for host option as well. This PR changed the order of the click help option so the --help will be used in autogenerated help messages.

Related issue number

Closes https://anyscaleteam.slack.com/archives/C043A9QJLNR/p1690471497886949

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Gene Su <e870252314@gmail.com>
@GeneDer
Copy link
Contributor Author

GeneDer commented Jul 27, 2023

Tested serve -h, serve --help, and serve run --help are all working. serve run command now sees the correct help message
image

@GeneDer GeneDer self-assigned this Jul 27, 2023
@edoakes edoakes merged commit 4297ca6 into ray-project:master Jul 27, 2023
43 of 46 checks passed
@GeneDer GeneDer deleted the fix-serve-help-message branch July 27, 2023 19:27
edoakes pushed a commit to edoakes/ray that referenced this pull request Aug 2, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages.
edoakes pushed a commit to edoakes/ray that referenced this pull request Aug 2, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages.
Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
rickyyx pushed a commit that referenced this pull request Aug 8, 2023
Re: #35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages.

Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
Co-authored-by: Gene Der Su <e870252314@gmail.com>
NripeshN pushed a commit to NripeshN/ray that referenced this pull request Aug 15, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages.
Signed-off-by: NripeshN <nn2012@hw.ac.uk>
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages.
Signed-off-by: harborn <gangsheng.wu@intel.com>
harborn pushed a commit to harborn/ray that referenced this pull request Aug 17, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages.
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages.
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
Re: ray-project#35754 We previously added `-h` help command to the serve cli's click group. This caused the autogenerated help message to take `-h` as the default help command. For `serve run` we have a collusion on `-h` as it's used for host option as well. This PR changed the order of the click help option so the `--help` will be used in autogenerated help messages.
Signed-off-by: Victor <vctr.y.m@example.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants