Skip to content

Show-ServyHelp: .EXAMPLE does not demonstrate -Command parameter #57

@Christophe-Rogiers

Description

@Christophe-Rogiers

Bug Description

The .EXAMPLE section of Show-ServyHelp only shows basic usage without the -Command parameter, which is arguably the most useful way to call this function.

Actual Behavior

Lines 269-270:

.EXAMPLE
    Show-ServyHelp
    # Displays help for the Servy CLI.

The function has a -Command parameter with a ValidateSet of eight possible values, but none are shown in the examples.

Suggested Fix

Add a second example demonstrating the -Command parameter:

.EXAMPLE
    Show-ServyHelp
    # Displays general help for the Servy CLI.

.EXAMPLE
    Show-ServyHelp -Command "install"
    # Displays help for the install command.

Environment

  • PowerShell module: Servy.psm1
  • Affects: Show-ServyHelp function documentation (lines 253-286)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions