Add comment describing why -ia is not the alias for -InformationAction common parameter #10703
Conversation
|
There is a possibility of breaking existing scripts with parameters that has |
|
@daxian-dbw I thought about that, and did a search across all commands I have (native + installed modules like Azure, AWS, etc.) and across 9870 cmdlets there aren't any parameters that have Also, if what you suggest is tru
8000
e, why would |
|
@PowerShell/powershell-committee Please review the proposed new alias |
|
@PowerShell/powershell-committee reviewed this, since an explicit alias was chosen when Information Stream feature was added we investigated if there is a conflict with existing use of |
|
Thanks to @LeeHolmes who dug through ancient history, originally this parameter did have the |
|
@SteveL-MSFT Thanks to both of you. Not that this comes up often, but it would be worth having a comment in the code that points this out, no? I can always change this PR to just add that, or close this and submit another PR. |
|
@KirkMunro please update the PR to add a comment on why it's not |
|
Done. Aside: If tab completion used some fuzzy logic to match alias names, I think most parameter aliases wouldn't be necessary. |
|
@PoshChan please retry macos |
|
@SteveL-MSFT, successfully started retry of |
|
🎉 Handy links: |
PR Summary
This adds a comment highlighting why a common parameter alias name breaks the naming convention used for other common parameters.
PR Context
This comment is being added so that others looking at this code in the future will know why the alias naming convention is different in this case.
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:or[ WIP ]to the beginning of the title (theWIPbot will keep its status check atPendingwhile the prefix is present) and remove the prefix when the PR is ready.