Skip to content

Commit e0954a4

Browse files
committed
Fix broken links
1 parent a0a4739 commit e0954a4

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

reference/docs-conceptual/PSScriptAnalyzer/rules-recommendations.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,20 @@ No rules defined.
4747

4848
### Severity: TBD
4949

50-
- Support Force Parameter for Interactive Session
51-
- If your cmdlet is used interactively, always provide a Force parameter to override the interactive
52-
actions, such as prompts or reading lines of input). This is important because it allows your
53-
cmdlet to be used in non-interactive scripts and hosts. The following methods can be implemented
54-
by an interactive host.
55-
- Document Output Objects
50+
- Support **Force** parameter for interactive sessions. If your cmdlet is used interactively, always
51+
provide a **Force** parameter to override the interactive actions, such as prompts or reading
52+
lines of input. This is important because it allows your cmdlet to be used in non-interactive
53+
scripts and hosts. The following methods can be implemented by an interactive host.
54+
- Document output objects
5655
- Module must be loadable
5756
- No syntax errors
5857
- Unresolved dependencies are an error
5958
- Derive from the Cmdlet or PSCmdlet Classes
6059
- Specify the Cmdlet Attribute
6160
- Override an Input Processing Method
6261
- Specify the OutputType Attribute
63-
- Write Single Records to the Pipeline
64-
- Make Cmdlets Case-Insensitive and Case-Preserving
62+
- Write single records to the pipeline
63+
- Make cmdlets case-insensitive and case-preserving
6564

6665
## Script Functions
6766

@@ -166,11 +165,11 @@ No rules defined.
166165
### Severity: Error
167166

168167
- Use standard DSC methods
169-
[StandardDSCFunctionsInResource](Rules/StandardDSCFunctionsInResource.md)
168+
[StandardDSCFunctionsInResource](Rules/DSCStandardDSCFunctionsInResource.md)
170169
- Use identical mandatory parameters for all DSC methods
171-
[UseIdenticalMandatoryParametersForDSC](Rules/UseIdenticalMandatoryParametersForDSC.md)
170+
[UseIdenticalMandatoryParametersForDSC](Rules/DSCUseIdenticalMandatoryParametersForDSC.md)
172171
- Use identical parameters for Set and Test DSC methods
173-
[UseIdenticalParametersForDSC](Rules/UseIdenticalParametersForDSC.md)
172+
[UseIdenticalParametersForDSC](Rules/DSCUseIdenticalParametersForDSC.md)
174173

175174
### Severity: Warning
176175

@@ -179,12 +178,12 @@ No rules defined.
179178
### Severity: Information
180179

181180
- The following three recommendations are covered by the
182-
[ReturnCorrectTypesForDSCFunctions](Rules/ReturnCorrectTypesForDSCFunctions.md) rule
181+
[ReturnCorrectTypesForDSCFunctions](Rules/DSCReturnCorrectTypesForDSCFunctions.md) rule
183182
- Avoid returning any object from a `Set-TargetResource` or Set (Class Based) function
184183
- Returning a Boolean object from a `Test-TargetResource` or Test (Class Based) function
185184
- Returning an object from a `Get-TargetResource` or Get (Class Based) function
186-
- DSC resources should have DSC tests [DSCTestsPresent](Rules/DscTestsPresent.md)
187-
- DSC resources should have DSC examples [DSCExamplesPresent](Rules/DscExamplesPresent.md)
185+
- DSC resources should have DSC tests [DSCTestsPresent](Rules/DSCDscTestsPresent.md)
186+
- DSC resources should have DSC examples [DSCExamplesPresent](Rules/DSCDscExamplesPresent.md)
188187

189188
### Severity: TBD
190189

reference/docs-conceptual/PSScriptAnalyzer/using-scriptanalyzer.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,8 @@ Suppress violation in `start-bar`, `start-baz` and `start-bam` but not in `start
141141
Param()
142142
```
143143

144-
**Note**: Parser Errors cannot be suppressed via the `SuppressMessageAttribute`
144+
> [!NOTE]
145+
> Parser errors cannot be suppressed via the `SuppressMessageAttribute`.
145146
146147
## Settings Support in ScriptAnalyzer
147148

0 commit comments

Comments
 (0)