Powershell Help Generator
Generates powershell help template for the the selected method name
Labels help doc
Details
Installs
- Total 16K
- Win 13K
- Mac 2K
- Linux 974
| Jul 1 | Jun 30 | Jun 29 | Jun 28 | Jun 27 | Jun 26 | Jun 25 | Jun 24 | Jun 23 | Jun 22 | Jun 21 | Jun 20 | Jun 19 | Jun 18 | Jun 17 | Jun 16 | Jun 15 | Jun 14 | Jun 13 | Jun 12 | Jun 11 | Jun 10 | Jun 9 | Jun 8 | Jun 7 | Jun 6 | Jun 5 | Jun 4 | Jun 3 | Jun 2 | Jun 1 | May 31 | May 30 | May 29 | May 28 | May 27 | May 26 | May 25 | May 24 | May 23 | May 22 | May 21 | May 20 | May 19 | May 18 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 0 | 3 | 2 | 0 | 1 | 3 | 1 | 0 | 1 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 1 | 3 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 2 | 4 | 2 | 0 | 0 | 0 | 2 | 0 | 3 | 0 | 3 | 2 | 0 | 1 | 0 | 0 | 2 | 0 | 1 |
| Mac | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
sublime_powershell_help
Generates powershell help template for the the selected method name
Installation
Clone repository to your packages directory
Sublime 2: %APPDATA%\Sublime Text 2\Packages Sublime 3: %APPDATA%\Sublime Text 3\Packages
git clone https://github.com/sponte/sublime_powershell_help.git "%APPDATA%\Sublime Text 3\Packages\sublime_powershell_help"
Usage
Put your cursor on the line where your cmdlet is, press CTRL + SHIFT + P and find Document Cmdlet command. Once you run it it will preped documentation template above the function.
Notes
Your method needs to be discoverable to powershell i.e. it needs to be a exported method in the module that is on the PSModulePath.
Currently there is no error handling and verification. It will prepend documentation twice if you call it twice on the same method.