PowerShell / Polaris

A cross-platform, minimalist web framework for PowerShell
https://powershell.github.io/Polaris/
MIT License
508 stars 113 forks source link

Better API documentation #153

Open Tiberriver256 opened 5 years ago

Tiberriver256 commented 5 years ago

Could we create our own PSScriptAnalyzer rule to keep track of this for us? Probably worth investigating if we can keep track of this automatically so our docs stay in-sync with our code changes moving forward.

Created from #135

TylerLeonhardt commented 5 years ago

I have one request:

Private functions only need a comment above them. Not the full comment-based help.

157 fixes the first 3