Skip to content

Commit 2fc3911

Browse files
bergmeisterJamesWTruher
authored andcommitted
Remove outdated about_scriptanalyzer help file (#951)
* remove old cmdlet help file that is not needed any more due to help being markdown based. * Remove about_scriptanalyzer copy step from build and links to it in markdown. Also correct version of platyps
1 parent 6e892b9 commit 2fc3911

File tree

5 files changed

+3
-268
lines changed

5 files changed

+3
-268
lines changed

.build.ps1

-3
Original file line numberDiff line numberDiff line change
@@ -188,9 +188,6 @@ task buildDocs -Inputs $bdInputs -Outputs $bdOutputs {
188188
$markdownDocsPath = Join-Path $docsPath 'markdown'
189189
CreateIfNotExists($outputDocsPath)
190190

191-
# copy the about help file
192-
Copy-Item -Path $docsPath\about_PSScriptAnalyzer.help.txt -Destination $outputDocsPath -Force
193-
194191
# Build documentation using platyPS
195192
if ($null -eq (Get-Module platyPS -ListAvailable -Verbose:$verbosity | Where-Object { $_.Version -ge 0.9 })) {
196193
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"

build.ps1

+1-3
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,9 @@ if ($BuildDocs)
9191
$outputDocsPath = Join-Path $destinationPath en-US
9292

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

9795
# Build documentation using platyPS
98-
if ($null -eq (Get-Module platyPS -ListAvailable -Verbose:$verbosity | Where-Object { $_.Version -ge 0.5 }))
96+
if ($null -eq (Get-Module platyPS -ListAvailable -Verbose:$verbosity | Where-Object { $_.Version -ge 0.9 }))
9997
{
10098
"Cannot find platyPS. Please install it from https://www.powershellgallery.com/packages/platyPS/ using e.g. the following command: Install-Module platyPS"
10199
}

docs/about_PSScriptAnalyzer.help.txt

-251
This file was deleted.

docs/markdown/Get-ScriptAnalyzerRule.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,9 @@ Use this cmdlet to create collections of rules to include and exclude when runni
2323
To get information about the rules, see the value of the Description property of each rule.
2424

2525
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.
26-
For more information about PSScriptAnalyzer, type: Get-Help about_PSScriptAnalyzer.
2726

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

3130
## EXAMPLES
3231

@@ -166,7 +165,4 @@ The RuleInfo object is a custom object created especially for Script Analyzer. I
166165
167166
[Invoke-ScriptAnalyzer]()
168167
169-
[about_PSScriptAnalyzer]()
170-
171168
[PSScriptAnalyzer on GitHub](https://github.com/PowerShell/PSScriptAnalyzer)
172-

docs/markdown/Invoke-ScriptAnalyzer.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,9 @@ For usage in CI systems, the -EnableExit exits the shell with an exit code equal
5252

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

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

6159
## EXAMPLES
6260

@@ -538,7 +536,4 @@ If you use the SuppressedOnly parameter, Invoke-ScriptAnalyzer instead returns a
538536
539537
[Get-ScriptAnalyzerRule]()
540538
541-
[about_PSScriptAnalyzer]()
542-
543539
[PSScriptAnalyzer on GitHub](https://github.com/PowerShell/PSScriptAnalyzer)
544-

0 commit comments

Comments
 (0)