dsc resources description #106
Conversation
Codecov Report
@@ Coverage Diff @@
## dev #106 +/- ##
===================================
Coverage 83% 83%
===================================
Files 19 19
Lines 2755 2755
Branches 4 4
===================================
Hits 2300 2300
Misses 451 451
Partials 4 4 |
| @@ -19,6 +25,10 @@ $script:maxUserEnvVariableLength = 255 | |||
| Retrieves the state of the environment variable. If both Machine and Process Target are | |||
| specified, only the machine value will be returned. | |||
|
|
|||
| .DESCRIPTION | |||
There was a problem hiding this comment.
Resource description should not be added here since it was already added at the top
| @@ -33,11 +43,12 @@ function Get-TargetResource | |||
| [OutputType([Hashtable])] | |||
| param | |||
| ( | |||
| [Parameter(Mandatory = $true)] | |||
| [Parameter(Mandatory = $true, HelpMessage="Indicates the name of the environment variable for which you want to ensure a specific state.")] | |||
There was a problem hiding this comment.
Most other resources only have HelpMessages added only to Set, but these are added in Get?
| @@ -91,11 +95,12 @@ function Get-TargetResource | |||
| [CmdletBinding()] | |||
| param | |||
| ( | |||
| [Parameter(Mandatory = $true)] | |||
| [Parameter(Mandatory = $true, HelpMessage="The name of the group to create, modify, or remove.")] | |||
There was a problem hiding this comment.
HelpMessage properties should be added to the parameters of SetTargetResource instead of GetTargetResource
| Creates, modifies, or deletes a user. | ||
|
|
||
| #> | ||
|
|
There was a problem hiding this comment.
There are no parameter HelpMessages added for this resource?
| [ValidateNotNullOrEmpty()] | ||
| [String[]] | ||
| $Name, | ||
|
|
||
| [Parameter(HelpMessage="Specifies whether the roles or features should be installed or uninstalled. | ||
|
|
There was a problem hiding this comment.
Does this work with the extra blank newline in a normal string?
| @@ -85,26 +91,26 @@ function Get-TargetResource | |||
| [CmdletBinding()] | |||
| param | |||
| ( | |||
| [Parameter(Mandatory = $true)] | |||
| [Parameter(Mandatory = $true, HelpMessage="The path to the archive file that should be expanded to or removed from the specified destination.")] | |||
There was a problem hiding this comment.
Most other resources only have HelpMessages added only to Set, but these are added in Get?
README.md
Outdated
| @@ -579,6 +579,7 @@ The following parameters will be the same for each process in the set: | |||
|
|
|||
| ### 2.8.0.0 | |||
|
|
|||
| * Added Description and Parameter description for composite resources | |||
There was a problem hiding this comment.
Please move this release note into the Unreleased section above. Version 2.8.0.0 has already been released.
johlju
added
waiting for code fix
|
verified the new line spacing for param description and our backend will remove the new line and display all in one line only |
johlju
removed
the
waiting for code fix
dsc resources description updated for VM Attach scnearios
This change is