Skip to content

Fix typos in about_Comment_Based_Help.md #2305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 9, 2018
Merged

Fix typos in about_Comment_Based_Help.md #2305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8357cb0
Fix typos.
sethvs Apr 6, 2018
43b23de
Two more fixes.
sethvs Apr 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions reference/3.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ or

```powershell
<#
.< help keyword>
< help content>
.<help keyword>
<help content>
#>
function Get-Function { }
```
Expand All @@ -138,7 +138,7 @@ locations in the script.
- At the beginning of the script file. Script help can be preceded in the
script only by comments and blank lines.

- If the first item in the script body (after the help) is a function
If the first item in the script body (after the help) is a function
declaration, there must be at least two blank lines between the end of the
script help and the function declaration. Otherwise, the help is interpreted
as being help for the function, not help for the script.
Expand All @@ -155,6 +155,7 @@ For example:
<help content>
#>


function Get-Function { }
```

Expand All @@ -164,8 +165,8 @@ or
function Get-Function { }

<#
.< help keyword>
< help content>
.<help keyword>
<help content>
#>
```

Expand All @@ -180,11 +181,10 @@ XML-based help files for the functions in a script module, you must add an
"ExternalHelp" comment to each function.

```powershell
.ExternalHelp <XML-file-name>
# .ExternalHelp <XML-file-name>
function <function-name>
{
# ...

...
}
```

Expand Down
16 changes: 8 additions & 8 deletions reference/4.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ or

```powershell
<#
.< help keyword>
< help content>
.<help keyword>
<help content>
#>
function Get-Function { }
```
Expand All @@ -138,7 +138,7 @@ locations in the script.
- At the beginning of the script file. Script help can be preceded in the
script only by comments and blank lines.

- If the first item in the script body (after the help) is a function
If the first item in the script body (after the help) is a function
declaration, there must be at least two blank lines between the end of the
script help and the function declaration. Otherwise, the help is interpreted
as being help for the function, not help for the script.
Expand All @@ -155,6 +155,7 @@ For example:
<help content>
#>


function Get-Function { }
```

Expand All @@ -164,8 +165,8 @@ or
function Get-Function { }

<#
.< help keyword>
< help content>
.<help keyword>
<help content>
#>
```

Expand All @@ -180,11 +181,10 @@ XML-based help files for the functions in a script module, you must add an
"ExternalHelp" comment to each function.

```powershell
.ExternalHelp <XML-file-name>
# .ExternalHelp <XML-file-name>
function <function-name>
{
# ...

...
}
```

Expand Down
16 changes: 8 additions & 8 deletions reference/5.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ or

```powershell
<#
.< help keyword>
< help content>
.<help keyword>
<help content>
#>
function Get-Function { }
```
Expand All @@ -138,7 +138,7 @@ locations in the script.
- At the beginning of the script file. Script help can be preceded in the
script only by comments and blank lines.

- If the first item in the script body (after the help) is a function
If the first item in the script body (after the help) is a function
declaration, there must be at least two blank lines between the end of the
script help and the function declaration. Otherwise, the help is interpreted
as being help for the function, not help for the script.
Expand All @@ -155,6 +155,7 @@ For example:
<help content>
#>


function Get-Function { }
```

Expand All @@ -164,8 +165,8 @@ or
function Get-Function { }

<#
.< help keyword>
< help content>
.<help keyword>
<help content>
#>
```

Expand All @@ -180,11 +181,10 @@ XML-based help files for the functions in a script module, you must add an
"ExternalHelp" comment to each function.

```powershell
.ExternalHelp <XML-file-name>
# .ExternalHelp <XML-file-name>
function <function-name>
{
# ...

...
}
```

Expand Down
16 changes: 8 additions & 8 deletions reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ or

```powershell
<#
.< help keyword>
< help content>
.<help keyword>
<help content>
#>
function Get-Function { }
```
Expand All @@ -138,7 +138,7 @@ locations in the script.
- At the beginning of the script file. Script help can be preceded in the
script only by comments and blank lines.

- If the first item in the script body (after the help) is a function
If the first item in the script body (after the help) is a function
declaration, there must be at least two blank lines between the end of the
script help and the function declaration. Otherwise, the help is interpreted
as being help for the function, not help for the script.
Expand All @@ -155,6 +155,7 @@ For example:
<help content>
#>


function Get-Function { }
```

Expand All @@ -164,8 +165,8 @@ or
function Get-Function { }

<#
.< help keyword>
< help content>
.<help keyword>
<help content>
#>
```

Expand All @@ -180,11 +181,10 @@ XML-based help files for the functions in a script module, you must add an
"ExternalHelp" comment to each function.

```powershell
.ExternalHelp <XML-file-name>
# .ExternalHelp <XML-file-name>
function <function-name>
{
# ...

...
}
```

Expand Down
16 changes: 8 additions & 8 deletions reference/6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ or

```powershell
<#
.< help keyword>
< help content>
.<help keyword>
<help content>
#>
function Get-Function { }
```
Expand All @@ -138,7 +138,7 @@ locations in the script.
- At the beginning of the script file. Script help can be preceded in the
script only by comments and blank lines.

- If the first item in the script body (after the help) is a function
If the first item in the script body (after the help) is a function
declaration, there must be at least two blank lines between the end of the
script help and the function declaration. Otherwise, the help is interpreted
as being help for the function, not help for the script.
Expand All @@ -155,6 +155,7 @@ For example:
<help content>
#>


function Get-Function { }
```

Expand All @@ -164,8 +165,8 @@ or
function Get-Function { }

<#
.< help keyword>
< help content>
.<help keyword>
<help content>
#>
```

Expand All @@ -180,11 +181,10 @@ XML-based help files for the functions in a script module, you must add an
"ExternalHelp" comment to each function.

```powershell
.ExternalHelp <XML-file-name>
# .ExternalHelp <XML-file-name>
function <function-name>
{
# ...

...
}
```

Expand Down