DSC resources need to expose (comment-based?) help
Votes from Connect: 19
Original Date Submitted: 3/20/2014 5:52:05 AM
Site Name: PowerShell
Feedback ID: 836980
Frequency: Always Happens
Regression: No, this is new to the most recent version
Although a DSC resource is a PowerShell module that exports three specified functions, users don't "see" it that way; they see a resource as a single monolithic unit. But because the resource is an odd sort of sub-module of a root module, the resource can't readily expose help. In other words, I'd like to be able to run Get-DscHelp <resource_name> to see a description of the resource, a description for each setting within the resource, etc. I think you could probably do this with comment-based help IN the actual resource module (since the Set- and Test- functions would have the same signature, you might as well make this a module-level thing), but you'd need something other than Get-Help to know where to go get it. This would be a lot more in keeping with the way PowerShell works, instead of relying on web-based documentation for everything - which third parties might not keep up, as they start writing their own resources.
Product Studio item created by Connect Synchronizer due to creation of feedback ID 836980 (http://connect.microsoft.com/PowerShell/feedback/ViewFeedback.aspx?FeedbackID=836980).
Internal BugId: 7679