Azure / autorest.powershell

AutoRest PowerShell Generator
MIT License
110 stars 76 forks source link

Description for the DontShow parameters should provide more info #1248

Open isra-fel opened 9 months ago

isra-fel commented 9 months ago

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 commented 9 months ago

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 commented 8 months ago

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.