Skip to content

Remove outdated about_scriptanalyzer help file #951

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

Merged
merged 2 commits into from
Apr 9, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -188,9 +188,6 @@ task buildDocs -Inputs $bdInputs -Outputs $bdOutputs {
$markdownDocsPath = Join-Path $docsPath 'markdown'
CreateIfNotExists($outputDocsPath)

# copy the about help file
Copy-Item -Path $docsPath\about_PSScriptAnalyzer.help.txt -Destination $outputDocsPath -Force

# Build documentation using platyPS
if ($null -eq (Get-Module platyPS -ListAvailable -Verbose:$verbosity | Where-Object { $_.Version -ge 0.9 })) {
throw "Cannot find platyPS of version greater or equal to 0.9. Please install it from https://www.powershellgallery.com/packages/platyPS/ using e.g. the following command: Install-Module platyPS"
Expand Down
4 changes: 1 addition & 3 deletions build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,9 @@ if ($BuildDocs)
$outputDocsPath = Join-Path $destinationPath en-US

CreateIfNotExists($outputDocsPath)
# copy the about help file
Copy-Item -Path $docsPath\about_PSScriptAnalyzer.help.txt -Destination $outputDocsPath -Force -Verbose:$verbosity

# Build documentation using platyPS
if ($null -eq (Get-Module platyPS -ListAvailable -Verbose:$verbosity | Where-Object { $_.Version -ge 0.5 }))
if ($null -eq (Get-Module platyPS -ListAvailable -Verbose:$verbosity | Where-Object { $_.Version -ge 0.9 }))
{
"Cannot find platyPS. Please install it from https://www.powershellgallery.com/packages/platyPS/ using e.g. the following command: Install-Module platyPS"
}
Expand Down
251 changes: 0 additions & 251 deletions docs/about_PSScriptAnalyzer.help.txt

This file was deleted.

6 changes: 1 addition & 5 deletions docs/markdown/Get-ScriptAnalyzerRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,9 @@ Use this cmdlet to create collections of rules to include and exclude when runni
To get information about the rules, see the value of the Description property of each rule.

The PSScriptAnalyzer module tests the Windows PowerShell code in a script, module, or DSC resource to determine whether, and to what extent, it fulfils best practice standards.
For more information about PSScriptAnalyzer, type: Get-Help about_PSScriptAnalyzer.

PSScriptAnalyzer is an open-source project.
To contribute or file an issue, see GitHub.com\PowerShell\PSScriptAnalyzer.
For more information about PSScriptAnalyzer, to contribute or file an issue, see GitHub.com\PowerShell\PSScriptAnalyzer.

## EXAMPLES

Expand Down Expand Up @@ -166,7 +165,4 @@ The RuleInfo object is a custom object created especially for Script Analyzer. I

[Invoke-ScriptAnalyzer]()

[about_PSScriptAnalyzer]()

[PSScriptAnalyzer on GitHub](https://github.com/PowerShell/PSScriptAnalyzer)

7 changes: 1 addition & 6 deletions docs/markdown/Invoke-ScriptAnalyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,9 @@ For usage in CI systems, the -EnableExit exits the shell with an exit code equal

The PSScriptAnalyzer module tests the Windows PowerShell code in a script, module, or DSC resource to determine
whether, and to what extent, it fulfils best practice standards.
For more information about PSScriptAnalyzer, type:
Get-Help about_PSScriptAnalyzer.

PSScriptAnalyzer is an open-source project.
To contribute or file an issue, see GitHub.com\PowerShell\PSScriptAnalyzer.
For more information about PSScriptAnalyzer, to contribute or file an issue, see GitHub.com\PowerShell\PSScriptAnalyzer.

## EXAMPLES

Expand Down Expand Up @@ -538,7 +536,4 @@ If you use the SuppressedOnly parameter, Invoke-ScriptAnalyzer instead returns a

[Get-ScriptAnalyzerRule]()

[about_PSScriptAnalyzer]()

[PSScriptAnalyzer on GitHub](https://github.com/PowerShell/PSScriptAnalyzer)