Skip to content

Update help format to use proper case#10678

Merged
adityapatwardhan merged 2 commits intoPowerShell:masterfrom
ThomasNieto:fix
Oct 4, 2019
Merged

Update help format to use proper case#10678
adityapatwardhan merged 2 commits intoPowerShell:masterfrom
ThomasNieto:fix

Conversation

@ThomasNieto
Copy link
Copy Markdown
Contributor

PR Summary

This PR is to update the help format to use proper case in the remark section for the cmdlet and parameter, for example get-help -example to Get-Help -Example. It also removes the period at the end of the line to match online help.

Before

To see the examples, type: "get-help Get-Command -examples".
For more information, type: "get-help Get-Command -detailed".
For technical information, type: "get-help Get-Command -full".
For online help, type: "get-help Get-Command -online"

After

To see the examples, type: "Get-Help Get-Command -Examples"
For more information, type: "Get-Help Get-Command -Detailed"
For technical information, type: "Get-Help Get-Command -Full"
For online help, type: "Get-Help Get-Command -Online"

PR Context

PR Checklist

@iSazonov iSazonov added the CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log label Oct 2, 2019
@iSazonov iSazonov added this to the 7.0.0-preview.5 milestone Oct 2, 2019
@adityapatwardhan adityapatwardhan merged commit 7f6e656 into PowerShell:master Oct 4, 2019
@ghost
Copy link
Copy Markdown

ghost commented Oct 23, 2019

🎉v7.0.0-preview.5 has been released which incorporates this pull request.:tada:

Handy links:

@ThomasNieto ThomasNieto deleted the fix branch January 7, 2020 03:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants