PowerShell HelpWriter™ is an essential application to have in your toolbox, especially when working with existing scripts, functions, or modules. Eventually, your scripts will be shared or given to someone else to maintain, and no one wants to inherit a script that is hard to follow or difficult to understand. Including Help documentation with your […]
Tag: PowerShell Help
Friday Puzzle: Phantom Help
On Friday, December 16, 2016, I posted the following puzzle on Twitter. It shows a function that has no comment-based help or XML help, but when you run Get-Help on the function, Get-Help displays both a description and notes for the function. What is the source of help for this function? I call this unintentional […]
HelpUri v. HelpInfoUri
Although the names are similar and often confused, these properties are different. If you confuse them, the help for your PowerShell commands and modules won’t work. The HelpUri property stores the URL (http or https) of online help for a command. It’s a property of commands (cmdlets, functions, workflows). When a user runs Get-Help -Online, […]
Writing Help for Dynamic Parameters
Because dynamic parameters can be added to a command from multiple sources, the command author (who writes the help) cannot predict the dynamic parameters that might be available at runtime. Therefore, Get-Help expects dynamic parameters to be documented in the help file for the code that adds the dynamic parameters; not the code that has […]
Scope in a PowerShell GUI App
If you search the SAPIEN blog, you’ll realize that this is the not our first blog about scope in PowerShell GUIs. In March 2013, SAPIEN CTO Alex Riedel wrote First Rule of PowerShell Scoping Rules, a title that implies the final word in a discussion that wasn’t easy to end. Alex’s blog explained the differences […]
New SAPIEN Update tool integrated into all 2015 products
With the release of the latest versions of the 2015 SAPIEN products we also integrated a new update tool. This new version will check for updates on all licensed and unexpired trial version of our products. It can download and install the updated versions without you going to your accounts page. If you need to […]
