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

Description for the DontShow parameters should provide more info #1248

Open
isra-fel opened this issue Sep 26, 2023 · 2 comments
Open

Description for the DontShow parameters should provide more info #1248

isra-fel opened this issue Sep 26, 2023 · 2 comments

Comments

@isra-fel
Copy link
Member

For the DontShow parameters like -Proxy or -AppendPipeline, although we are hiding them from the online doc, but when the in-tool help still displays those parameters.
image

We should consider being more descriptive, add works like "This cmdlet is for internal use only........".

@JimMoyle
Copy link

In the medium to long term, would there be an opportunity to do the internal mock testing using these parameters, then a second export without them, this would eliminate the issue entirely.

In the short term we should definitely tell customers that these parameters are for internal MSFT use only.

@dolauli
Copy link
Contributor

dolauli commented Oct 19, 2023

For [-Break] [-HttpPipelineAppend] [-HttpPipelinePrepend], which are for internal use, will add descriptions to tell users they are for internal use only.

For [-Proxy] [-ProxyCredential], [-ProxyUseDefaultCredentials], which are used to support cmdlet level proxy. Will add description to recommend users to use system level proxy support. And if usage is low, will considering to deprecate cmdlet level proxy support.

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

No branches or pull requests

3 participants