Skip to content

fix option name - #3624

Merged
mairaw merged 7 commits into
dotnet:masterfrom
mairaw:mairaw-patch-3
Mar 21, 2018
Merged

mairaw merged 7 commits into
dotnet:masterfrom
mairaw:mairaw-patch-3

Conversation

@mairaw

@mairaw mairaw commented Nov 6, 2017 •

Copy link
Copy Markdown
Contributor

LiveFyre comment for topic https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet:

"The --verbose option is pretty confusing.

First, the .NET Core SDK 2.0.2 reports the option as named --verbosity (not --verbose) and it requires a value from a set composed by q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic].

Then, I tried every possible combination but I still can't understand how they're supposed to work. None of these commands succeeded (tried with dotnet new console).

dotnet new console -v
dotnet new console -v d
dotnet new console -vd
dotnet new console -v=d
dotnet new console --verbose

Please improve the documentation."

@dsplaisted @livarcocc does dotnet new support the verbosity flag? This is still listed as a common option when we do dotnet --h but it doesn't seem to work for all commands.

Internal Review URL

Comment thread docs/core/tools/dotnet.md Outdated
`-v|--verbose`
`-v|--verbosity`

Enables verbose output.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This should specify the options for verbosity, which I think are: q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]

@jzeferino jzeferino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This LGTM.

@BillWagner BillWagner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I ran through the commands here, and this LTGM.

@mairaw you can :shipit: when ready

@mairaw

mairaw commented Feb 13, 2018

Copy link
Copy Markdown
Contributor Author

Sorry for the delay here. I made the suggested changes but I'm still not sure whether it's the right thing to list this as a common option or if we should simply remove this option from this page since it doesn't work with every command. Thoughts @dsplaisted?

@mairaw mairaw self-assigned this Feb 13, 2018
@mairaw mairaw added Area - .NET Core Guide waiting-on-feedback Waiting for feedback from SMEs before they can be merged labels Feb 13, 2018
@mairaw

mairaw commented Feb 14, 2018 •

Copy link
Copy Markdown
Contributor Author

@KathleenDollard should we mention that verbose doesn't work for all commands or remove it from this topic (and perhaps from dotnet -h too)? It's listed as a common option but it doesn't for all commands, so it's causing customer confusion.

@KathleenDollard

Copy link
Copy Markdown
Contributor

Can we just mark it with a note? It clarifies that it should always be just like this if it exists, but it doesn't always exist.

@mairaw

mairaw commented Feb 22, 2018

Copy link
Copy Markdown
Contributor Author

Sure, I'll add that @KathleenDollard.

@mairaw mairaw modified the milestones: Sprint 132 (2/24/18 - 3/16/18), Sprint 133 (3/19/18 - 4/06/18) Mar 20, 2018
@mairaw

mairaw commented Mar 21, 2018

Copy link
Copy Markdown
Contributor Author

@dsplaisted I decided to run some final tests before merging this. it seems that although dotnet --help for 1.x versions lists the option name as --verbose, all the commands never accepted that and in fact just dotnet --help was displaying the wrong information for 1.x. Can you confirm?
I'll be adjusting this PR to reflect what I'm seeing on my tests.

/cc @KathleenDollard

@dsplaisted

Copy link
Copy Markdown
Member

@mairaw I believe the help text was incorrect for 1.x, and we fixed it in 2.0. See https://github.com/dotnet/cli/issues/5502 and dotnet/cli#6690

@mairaw
mairaw merged commit 5ba9ae2 into dotnet:master Mar 21, 2018
@mairaw
mairaw deleted the mairaw-patch-3 branch March 21, 2018 18:58
@mairaw

mairaw commented Mar 21, 2018

Copy link
Copy Markdown
Contributor Author

Thanks @dsplaisted. So merged this with my last fix.

@mairaw mairaw removed the waiting-on-feedback Waiting for feedback from SMEs before they can be merged label Mar 21, 2018
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.

6 participants