From 060584611593c4b42123c2ed56881d44fa1f04c8 Mon Sep 17 00:00:00 2001 From: Peter Deister Date: Fri, 6 Jul 2018 22:36:18 +0200 Subject: [PATCH 1/3] 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_. --- developer/cmdlet/required-development-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/cmdlet/required-development-guidelines.md b/developer/cmdlet/required-development-guidelines.md index 259f2019435b..3f3cb82a0771 100644 --- a/developer/cmdlet/required-development-guidelines.md +++ b/developer/cmdlet/required-development-guidelines.md @@ -160,7 +160,7 @@ For a cmdlet to be recognized by Windows PowerShell, its .NET Framework class mu - The default parameter set that is used when multiple parameter sets are specified. The default parameter set is used when Windows PowerShell does not have enough information to determine which parameter set to use. -- Indicates if the cmdlet supports calls to the [System.Management.Automation.Cmdlet.Shouldprocess*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldProcess) method. This method displays a confirmation message to the user before the cmdlet make a change to the system. For more information about how confirmation requests are made, see [Requesting Confirmation](./requesting-confirmation-from-cmdlets.md). +- Indicates if the cmdlet supports calls to the [System.Management.Automation.Cmdlet.Shouldprocess*](/dotnet/api/System.Management.Automation.Cmdlet.ShouldProcess) method. This method displays a confirmation message to the user before the cmdlet makes a change to the system. For more information about how confirmation requests are made, see [Requesting Confirmation](./requesting-confirmation-from-cmdlets.md). - Indicate the impact level (or severity) of the action associated with the confirmation message. In most cases, the default value of Medium should be used. For more information about how the impact level affects the confirmation requests that are displayed to the user, see [Requesting Confirmation](./requesting-confirmation-from-cmdlets.md). From e322f50feb26602147a04a2549c835b742a92808 Mon Sep 17 00:00:00 2001 From: Peter Deister Date: Tue, 10 Jul 2018 00:43:32 +0200 Subject: [PATCH 2/3] Fixed anchors for internal links. Fixed anchors in interlnal links to sections dedicated to development guidelines. --- ...rongly-encouraged-development-guidelines.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/developer/cmdlet/strongly-encouraged-development-guidelines.md b/developer/cmdlet/strongly-encouraged-development-guidelines.md index e72a1e184bd2..4e3ab1144dd5 100644 --- a/developer/cmdlet/strongly-encouraged-development-guidelines.md +++ b/developer/cmdlet/strongly-encouraged-development-guidelines.md @@ -15,25 +15,25 @@ This section describes guidelines that you should follow when you write your cmd ## Design Guidelines -- [Use a Specific Noun for a Cmdlet Name (SD01)](./strongly-encouraged-development-guidelines.md#SD01) +- [Use a Specific Noun for a Cmdlet Name (SD01)](./strongly-encouraged-development-guidelines.md#use-a-specific-noun-for-a-cmdlet-name-sd01) -- [Use Pascal Case for Cmdlet Names (SD02)](./strongly-encouraged-development-guidelines.md#SD02) +- [Use Pascal Case for Cmdlet Names (SD02)](./strongly-encouraged-development-guidelines.md#use-pascal-case-for-cmdlet-names-sd02) -- [Parameter Design Guidelines (SD03)](./strongly-encouraged-development-guidelines.md#SD03) +- [Parameter Design Guidelines (SD03)](./strongly-encouraged-development-guidelines.md#parameter-design-guidelines-sd03) -- [Provide Feedback to the User (SD04)](./strongly-encouraged-development-guidelines.md#SD04) +- [Provide Feedback to the User (SD04)](./strongly-encouraged-development-guidelines.md#provide-feedback-to-the-user-sd04) -- [Create a Cmdlet Help File (SD05)](./strongly-encouraged-development-guidelines.md#SD05) +- [Create a Cmdlet Help File (SD05)](./strongly-encouraged-development-guidelines.md#create-a-cmdlet-help-file-sd05) ## Code Guidelines -- [Coding Parameters (SC01)](./strongly-encouraged-development-guidelines.md#SC01) +- [Coding Parameters (SC01)](./strongly-encouraged-development-guidelines.md#coding-parameters-sc01) -- [Support Well Defined Pipeline Input (SC02)](./strongly-encouraged-development-guidelines.md#SC02) +- [Support Well Defined Pipeline Input (SC02)](./strongly-encouraged-development-guidelines.md#support-well-defined-pipeline-input-sc02) -- [Write Single Records to the Pipeline (SC03)](./strongly-encouraged-development-guidelines.md#SC03) +- [Write Single Records to the Pipeline (SC03)](./strongly-encouraged-development-guidelines.md#write-single-records-to-the-pipeline-sc03) -- [Make Cmdlets Case-Insensitive and Case-Preserving (SC04)](./strongly-encouraged-development-guidelines.md#SC04) +- [Make Cmdlets Case-Insensitive and Case-Preserving (SC04)](./strongly-encouraged-development-guidelines.md#make-cmdlets-case-insensitive-and-case-preserving-sc04) ## Design Guidelines From 49a7d38a3d786f3dc458768e5550bc0d0fb700e9 Mon Sep 17 00:00:00 2001 From: Peter Deister Date: Tue, 10 Jul 2018 00:48:42 +0200 Subject: [PATCH 3/3] Removed two duplicate sentences, --- developer/cmdlet/strongly-encouraged-development-guidelines.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/developer/cmdlet/strongly-encouraged-development-guidelines.md b/developer/cmdlet/strongly-encouraged-development-guidelines.md index 4e3ab1144dd5..47c82813e956 100644 --- a/developer/cmdlet/strongly-encouraged-development-guidelines.md +++ b/developer/cmdlet/strongly-encouraged-development-guidelines.md @@ -145,7 +145,6 @@ Cmdlet operations that take a long time to complete and that cannot run in the b 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. -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. 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. > [!NOTE] @@ -185,7 +184,6 @@ If the data that the cmdlet reads or writes is only a set of strings instead of 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. -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. 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. For more information about wildcard-character patterns, see [Supporting Wildcard Characters in Cmdlet Parameters](./supporting-wildcard-characters-in-cmdlet-parameters.md).