Skip to content

[Documentation] Review all cmdlets to include simple output documentation #132

@msc365admin

Description

@msc365admin

Add a simply .OUTPUTS section specifying the output type, for example:

.OUTPUTS
    PSCustomObject

This keeps the help clean and avoids cluttering it with a full breakdown of all returned properties. I prefer not to include overly detailed documentation inside the comment-based help itself. The .LINKS section points to the official documentation where those details already live, and users can always run the cmdlet directly to inspect the complete output.

Including the output type is helpful because it helps users understand how to process the returned object in scripts and pipelines.

Also align the same simplification for all documentation files, keeping them consistent with this approach.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions