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

Better API documentation #153

@Tiberriver256

Description

@Tiberriver256
  • 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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions