Skip to content

Commit 9625dc4

Browse files
purdo17DCtheGeek
authored andcommitted
Fixed anchors for internal links. (#2678)
* Fix verb inflection Fix inflection of _make_ in the third item of the list in section _Derive from the Cmdlet or PSCmdlet Classes (RC01)_ to match the singular number of the subject, _the cmdlet_. * Fixed anchors for internal links. Fixed anchors in interlnal links to sections dedicated to development guidelines. * Removed two duplicate sentences,
1 parent 2d84b87 commit 9625dc4

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

developer/cmdlet/strongly-encouraged-development-guidelines.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@ This section describes guidelines that you should follow when you write your cmd
1515

1616
## Design Guidelines
1717

18-
- [Use a Specific Noun for a Cmdlet Name (SD01)](./strongly-encouraged-development-guidelines.md#SD01)
18+
- [Use a Specific Noun for a Cmdlet Name (SD01)](./strongly-encouraged-development-guidelines.md#use-a-specific-noun-for-a-cmdlet-name-sd01)
1919

20-
- [Use Pascal Case for Cmdlet Names (SD02)](./strongly-encouraged-development-guidelines.md#SD02)
20+
- [Use Pascal Case for Cmdlet Names (SD02)](./strongly-encouraged-development-guidelines.md#use-pascal-case-for-cmdlet-names-sd02)
2121

22-
- [Parameter Design Guidelines (SD03)](./strongly-encouraged-development-guidelines.md#SD03)
22+
- [Parameter Design Guidelines (SD03)](./strongly-encouraged-development-guidelines.md#parameter-design-guidelines-sd03)
2323

24-
- [Provide Feedback to the User (SD04)](./strongly-encouraged-development-guidelines.md#SD04)
24+
- [Provide Feedback to the User (SD04)](./strongly-encouraged-development-guidelines.md#provide-feedback-to-the-user-sd04)
2525

26-
- [Create a Cmdlet Help File (SD05)](./strongly-encouraged-development-guidelines.md#SD05)
26+
- [Create a Cmdlet Help File (SD05)](./strongly-encouraged-development-guidelines.md#create-a-cmdlet-help-file-sd05)
2727

2828
## Code Guidelines
2929

30-
- [Coding Parameters (SC01)](./strongly-encouraged-development-guidelines.md#SC01)
30+
- [Coding Parameters (SC01)](./strongly-encouraged-development-guidelines.md#coding-parameters-sc01)
3131

32-
- [Support Well Defined Pipeline Input (SC02)](./strongly-encouraged-development-guidelines.md#SC02)
32+
- [Support Well Defined Pipeline Input (SC02)](./strongly-encouraged-development-guidelines.md#support-well-defined-pipeline-input-sc02)
3333

34-
- [Write Single Records to the Pipeline (SC03)](./strongly-encouraged-development-guidelines.md#SC03)
34+
- [Write Single Records to the Pipeline (SC03)](./strongly-encouraged-development-guidelines.md#write-single-records-to-the-pipeline-sc03)
3535

36-
- [Make Cmdlets Case-Insensitive and Case-Preserving (SC04)](./strongly-encouraged-development-guidelines.md#SC04)
36+
- [Make Cmdlets Case-Insensitive and Case-Preserving (SC04)](./strongly-encouraged-development-guidelines.md#make-cmdlets-case-insensitive-and-case-preserving-sc04)
3737

3838
## Design Guidelines
3939

@@ -145,7 +145,6 @@ Cmdlet operations that take a long time to complete and that cannot run in the b
145145

146146
Occasionally, a cmdlet must communicate directly with the user instead of by using the various Write or Should methods supported by the [System.Management.Automation.Cmdlet](/dotnet/api/System.Management.Automation.Cmdlet) class. In this case, the cmdlet should derive from the [System.Management.Automation.Pscmdlet](/dotnet/api/System.Management.Automation.PSCmdlet) class and use the [System.Management.Automation.Pscmdlet.Host*](/dotnet/api/System.Management.Automation.PSCmdlet.Host) property. This property supports different levels of communication type, including the PromptForChoice, Prompt, and WriteLine/ReadLine types. At the most specific level, it also provides ways to read and write individual keys and to deal with buffers.
147147

148-
Unless a cmdlet is specifically designed to generate a graphical user interface (GUI), it should not bypass the host by using the [System.Management.Automation.Pscmdlet.Host*](/dotnet/api/System.Management.Automation.PSCmdlet.Host) property. An example of a cmdlet that is designed to generate a GUI is the [Out-GridView](/powershell/module/Microsoft.PowerShell.Utility/Out-GridView) cmdlet.
149148
Unless a cmdlet is specifically designed to generate a graphical user interface (GUI), it should not bypass the host by using the [System.Management.Automation.Pscmdlet.Host*](/dotnet/api/System.Management.Automation.PSCmdlet.Host) property. An example of a cmdlet that is designed to generate a GUI is the [Out-GridView](/powershell/module/Microsoft.PowerShell.Utility/Out-GridView) cmdlet.
150149

151150
> [!NOTE]
@@ -185,7 +184,6 @@ If the data that the cmdlet reads or writes is only a set of strings instead of
185184

186185
A cmdlet should support wildcard characters if possible. Support for wildcard characters occurs in many places in a cmdlet (especially when a parameter takes a string to identify one object from a set of objects). For example, the sample **Stop-Proc** cmdlet from the [StopProc Tutorial](./stopproc-tutorial.md) defines a `Name` parameter to handle strings that represent process names. This parameter supports wildcard characters so that the user can easily specify the processes to stop.
187186

188-
When support for wildcard characters is available, a cmdlet operation usually produces an array. Occasionally, it does not make sense to support an array because the user might use only a single item at a time. For example, the [Set-Location](/powershell/module/Microsoft.PowerShell.Management/Set-Location) cmdlet does not need to support an array because the user is setting only a single location. In this instance, the cmdlet still supports wildcard characters, but it forces resolution to a single location.
189187
When support for wildcard characters is available, a cmdlet operation usually produces an array. Occasionally, it does not make sense to support an array because the user might use only a single item at a time. For example, the [Set-Location](/powershell/module/Microsoft.PowerShell.Management/Set-Location) cmdlet does not need to support an array because the user is setting only a single location. In this instance, the cmdlet still supports wildcard characters, but it forces resolution to a single location.
190188

191189
For more information about wildcard-character patterns, see [Supporting Wildcard Characters in Cmdlet Parameters](./supporting-wildcard-characters-in-cmdlet-parameters.md).

0 commit comments

Comments
 (0)