Skip to content
This repository has been archived by the owner on Dec 8, 2021. It is now read-only.

Better API documentation #153

Open
3 of 5 tasks
Tiberriver256 opened this issue Nov 2, 2018 · 1 comment
Open
3 of 5 tasks

Better API documentation #153

Tiberriver256 opened this issue Nov 2, 2018 · 1 comment

Comments

@Tiberriver256
Copy link
Contributor

Tiberriver256 commented Nov 2, 2018

  • Ensure every function parameter is has a description
  • Ensure every function has at least 2 examples with description of what the code will do
  • Ensure every function has a full description of what that function does
  • Ensure every class has documentation
  • Ensure every property and method on classes have documentation

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
Copy link
Member

TylerLeonhardt commented Nov 10, 2018

I have one request:

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

#157 fixes the first 3

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants