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.

Sign up for GitHub

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

Jump to bottom

Update default help mode to 'options' and update error help message #5212

Closed
wants to merge 1 commit into from
Closed

Update default help mode to 'options' and update error help message #5212

wants to merge 1 commit into from

Conversation

Saurabh7019
Copy link
Contributor

Closes #5182

@Saurabh7019 Saurabh7019 changed the title Update default help mode to 'options' and enhance error help message display Update default help mode to 'options' and update error help message Jul 10, 2023
@Saurabh7019 Saurabh7019 marked this pull request as ready for review July 10, 2023 18:50
@martinlingstuyl
Copy link
Contributor

Hi @Saurabh7019, I believe you should target v7 branch, as this is a breaking change.

@martinlingstuyl
Copy link
Contributor

Aside from that, thanks!! We'll review it asap!

@Saurabh7019 Saurabh7019 changed the base branch from main to v7 July 10, 2023 20:46
@Saurabh7019
Copy link
Contributor Author

Thank you, Martin. I have changed the base to v7 now.

@milanholemans milanholemans added the pr-major PR for the next major release label Jul 23, 2023
@Adam-it Adam-it self-assigned this Jul 23, 2023
@Adam-it
Copy link
Contributor

Adam-it commented Jul 23, 2023

@Saurabh7019 thank you for your awesome work. You Rock 🤩. Checking the related issue I think the discussion is still open by the response given by @waldekmastykarz.
let's set this PR to draft so that we clarify if the way just to show part of help with suggestion on how to show the rest is the way to go. Thank you for your understanding and patience 👍

@Adam-it Adam-it marked this pull request as draft July 23, 2023 21:47
@Adam-it
Copy link
Contributor

Adam-it commented Jul 24, 2023

@Saurabh7019 for now let's update this PR only to set the new default help mode.
The new way of handling errors is move to a different issue and when agreed we will update it with a separate PR.

@Saurabh7019 Saurabh7019 marked this pull request as ready for review July 24, 2023 08:27
@Adam-it
Copy link
Contributor

Adam-it commented Jul 25, 2023

@Saurabh7019 thanks for the quick update. Could you please also align it with the latest v7 so that we may proceed with this PR👍

@Saurabh7019
Copy link
Contributor Author

Done!

Adam-it
Adam-it requested changes Aug 2, 2023
View reviewed changes
Copy link
Contributor

@Adam-it Adam-it left a comment

Choose a reason for hiding this comment

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

@Saurabh7019 this is a good start but there are some places we also need to update like:

  1. in the cli config description table we need to update the default value from full to options

    cli-microsoft365/docs/docs/_clisettings.mdx

    Line 12 in 7edcad2

    `helpMode`|Defines what part of command's help to display. Allowed values are `options`, `examples`, `remarks`, `response`, `full`|`full`
  2. the same goes for the _global.mdx this is the part of the help we include to every command. There we also need to update the description that now the default option will be options not full

    cli-microsoft365/docs/docs/cmd/_global.mdx

    Line 3 in 7edcad2

    : Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are `options`, `examples`, `remarks`, `response`, `full`. Default is `full`.

@Adam-it Adam-it marked this pull request as draft August 2, 2023 23:50
@Saurabh7019
Copy link
Contributor Author

Oh, I could have easily avoided the oversight if I hadn't been so eager. I will make the suggested changes now!

@Saurabh7019 Saurabh7019 marked this pull request as ready for review August 3, 2023 08:19
Adam-it
Adam-it approved these changes Aug 5, 2023
View reviewed changes
Copy link
Contributor

@Adam-it Adam-it left a comment

Choose a reason for hiding this comment

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

LGTM 👍
@Saurabh7019 thank you for your another awesome contribution. You rock 🤩

@Adam-it
Copy link
Contributor

Adam-it commented Aug 5, 2023

ready to merge 🚀

@Adam-it
Copy link
Contributor

Adam-it commented Aug 5, 2023

merged manually. Thank you for your awesome work 👏

@Adam-it Adam-it closed this Aug 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Adam-it Adam-it Adam-it approved these changes

Assignees

@Adam-it Adam-it

Labels
pr-major PR for the next major release pr-merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Set the default help mode to options
4 participants
@Saurabh7019 @martinlingstuyl @Adam-it @milanholemans