ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Powershell Help Generator

by sponte ALL

Generates powershell help template for the the selected method name

Labels help doc

Details

  • 2013.10.15.14.08.51
  • github.​com
  • github.​com
  • 7 years ago
  • 3 hours ago
  • 7 years ago

Installs

  • Total 13K
  • Win 10K
  • Mac 2K
  • Linux 714
Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11
Windows 2 2 0 2 4 5 2 4 1 0 2 2 5 3 4 1 1 2 4 4 5 6 5 0 3 1 1 3 0 0 0 1 3 3 0 1 1 4 3 0 1 2 2 2 3 3
Mac 0 0 0 0 0 0 2 0 0 0 2 0 1 0 0 0 0 1 1 0 0 1 0 0 0 1 0 0 1 0 0 1 0 0 2 0 0 0 2 0 0 0 1 0 1 0
Linux 0 0 0 1 0 0 3 2 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 1 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 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.