scripts

Optimize-Help.ps1

SYNOPSIS

Cleans up comment-based help blocks by fully unindenting and capitalizing dot keywords.

SYNTAX

Optimize-Help.ps1 [-Path] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

EXAMPLES

EXAMPLE 1

Optimize-Help.ps1 Get-Thing.ps1

Unindents help and capitalizes dot keywords in Get-Thing.ps1

PARAMETERS

-Path

The script to process.

Type: String
Parameter Sets: (All)
Aliases: FullName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ProgressAction

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

An object with a Path or FullName property.

OUTPUTS

NOTES