Type of issue
Missing information
Feedback
Invoke-ScriptAnalyzer's webpage says that -Settings can be "[a] path to a file containing a user-defined profile or a hashtable object containing settings for ScriptAnalyzer."
However, the "Built-In Presets" section of "Using PSScriptAnalyzer" says the -Settings parameter can accept the name of a preset.
If "Using PSScriptAnalyzer" is correct, then the documentation for Invoke-ScriptAnalyzer should say that the user may provide the name of a preset. And, the presets should be listed by name along with a way to learn more about each preset.
Page URL
https://learn.microsoft.com/en-us/powershell/module/psscriptanalyzer/invoke-scriptanalyzer?view=ps-modules
Content source URL
https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/blob/main/reference/ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md
Author
Sean Wheeler (@sdwheeler)
Platform Id
a7216b7c-9f23-8233-e0b4-d09fe28b8f92
Document Id
85b8afd5-5e0f-57b2-0702-5c80c469980a
Type of issue
Missing information
Feedback
Invoke-ScriptAnalyzer's webpage says that -Settings can be "[a] path to a file containing a user-defined profile or a hashtable object containing settings for ScriptAnalyzer."
However, the "Built-In Presets" section of "Using PSScriptAnalyzer" says the -Settings parameter can accept the name of a preset.
If "Using PSScriptAnalyzer" is correct, then the documentation for Invoke-ScriptAnalyzer should say that the user may provide the name of a preset. And, the presets should be listed by name along with a way to learn more about each preset.
Page URL
https://learn.microsoft.com/en-us/powershell/module/psscriptanalyzer/invoke-scriptanalyzer?view=ps-modules
Content source URL
https://github.com/MicrosoftDocs/PowerShell-Docs-Modules/blob/main/reference/ps-modules/PSScriptAnalyzer/Invoke-ScriptAnalyzer.md
Author
Sean Wheeler (@sdwheeler)
Platform Id
a7216b7c-9f23-8233-e0b4-d09fe28b8f92
Document Id
85b8afd5-5e0f-57b2-0702-5c80c469980a