Add PowerShell tab and examples to .NET reference pages in MSDN
Votes from Connect: 391
Original Date Submitted: 5/21/2015 12:20:32 AM
Handle: June Blender
Site Name: PowerShell
Feedback ID: 1351032
PowerShell users often read .NET reference pages in MSDN. It's all but required, because Get-Help doesn't describe object members. However, in the Examples section of .NET reference pages, there are no PowerShell examples; not even a PowerShell tab.
MSDN says they cannot demonstrate a demand for PowerShell examples. I'd like to use this feature request to demonstrate the demand.
Product Studio item created by Connect Synchronizer due to creation of feedback ID 1351032 (http://connect.microsoft.com/PowerShell/feedback/ViewFeedback.aspx?FeedbackID=1351032).
Internal BugId: 14500
https://github.com/dotnet/docs/issues/3455 The DotNet team is collecting feedback on this item as well.
Phil Sharpe commented
Examples would have helped me so many times over the past few years.
Toby Patton commented
Both - but examples would be more of a need for me. I hate seeing VBS,C+, etc and not seeing PS, on the little tabs because it's not provided.
Nisse, PowerShell documentation is open source at https://github.com/powershell/powershell-docs . If there are things you want to see added to the existing PowerShell documentation, that would be a great place to raise issues.
Just start by documenting PowerShell. That will go a long way.
And by documentation I mean real documentation with data types, exceptions return values (with data type). There should also be documentations of all prerequisites, assumptions and anything else that might affect how the cmdlet work.
Chrissy LeMaire commented
Examples for sure.
Warren F. commented
Both, IMHO prioritizing examples first. Like Martin said, on top of value as examples, folks can often imply syntax from those examples.
Francois-Xavier Cat commented
Both please Zachary
Martin Pugh commented
Agreed, Examples and then Syntax (most would be able to imply syntax if they can see an example or 2).
I'd say examples are more important, but I can't understand why you would have one without the other. Both would be preferred.
Brian T. Jackett commented
I prefer docs over example, but I see I am the minority here. I do understand though that "Lead/learn by example" is also a good way.
Michael Holzer commented
Both. Syntax should be automatically created first.
Johan Ljunggren commented
I would say both.
Chris Coulson commented
Stephen Owen commented
Syntax examples are what we're looking for. Give us an extra tab, just like this, with PowerShell examples of how to do the stuff we're shown how to do today in VB, C++ and C#.
I took the liberty of mocking up exactly what we're asking for.
Mike Shepard commented
Syntax would be nice, but it can be automatically generated so it would be a lot easier to include. Actual examples would be extremely useful and would necessarily include syntax.
Both but example is more important
Micah Rairdon commented
Both. Examples more useful to me.
Thomas Lee commented
i once added a bunch of samples - but MS seems to have removed a bunch of these.
If nothing else, allow community to add these examples. Open it back up again (and continue counting) and I'll happily add samples!