From 8357cb0f788eb55070ae6cd1567cb12f55703f8b Mon Sep 17 00:00:00 2001 From: sethvs Date: Fri, 6 Apr 2018 17:51:27 +0300 Subject: [PATCH 1/2] Fix typos. --- .../About/about_Comment_Based_Help.md | 16 ++++++++-------- .../About/about_Comment_Based_Help.md | 16 ++++++++-------- .../About/about_Comment_Based_Help.md | 16 ++++++++-------- .../About/about_Comment_Based_Help.md | 16 ++++++++-------- .../About/about_Comment_Based_Help.md | 12 ++++++------ 5 files changed, 38 insertions(+), 38 deletions(-) diff --git a/reference/3.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/3.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index 7bc4e70086d5..dcdce243b7d4 100644 --- a/reference/3.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/3.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -124,8 +124,8 @@ or ```powershell <# -.< help keyword> -< help content> +. + #> function Get-Function { } ``` @@ -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. @@ -155,6 +155,7 @@ For example: #> + function Get-Function { } ``` @@ -164,8 +165,8 @@ or function Get-Function { } <# -.< help keyword> -< help content> +. + #> ``` @@ -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 +# .ExternalHelp function { -# ... - + ... } ``` diff --git a/reference/4.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/4.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index 7bc4e70086d5..dcdce243b7d4 100644 --- a/reference/4.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/4.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -124,8 +124,8 @@ or ```powershell <# -.< help keyword> -< help content> +. + #> function Get-Function { } ``` @@ -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. @@ -155,6 +155,7 @@ For example: #> + function Get-Function { } ``` @@ -164,8 +165,8 @@ or function Get-Function { } <# -.< help keyword> -< help content> +. + #> ``` @@ -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 +# .ExternalHelp function { -# ... - + ... } ``` diff --git a/reference/5.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/5.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index 7bc4e70086d5..dcdce243b7d4 100644 --- a/reference/5.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/5.0/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -124,8 +124,8 @@ or ```powershell <# -.< help keyword> -< help content> +. + #> function Get-Function { } ``` @@ -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. @@ -155,6 +155,7 @@ For example: #> + function Get-Function { } ``` @@ -164,8 +165,8 @@ or function Get-Function { } <# -.< help keyword> -< help content> +. + #> ``` @@ -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 +# .ExternalHelp function { -# ... - + ... } ``` diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index 7bc4e70086d5..dcdce243b7d4 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -124,8 +124,8 @@ or ```powershell <# -.< help keyword> -< help content> +. + #> function Get-Function { } ``` @@ -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. @@ -155,6 +155,7 @@ For example: #> + function Get-Function { } ``` @@ -164,8 +165,8 @@ or function Get-Function { } <# -.< help keyword> -< help content> +. + #> ``` @@ -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 +# .ExternalHelp function { -# ... - + ... } ``` diff --git a/reference/6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index 7bc4e70086d5..8a6dbbe15e49 100644 --- a/reference/6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -124,8 +124,8 @@ or ```powershell <# -.< help keyword> -< help content> +. + #> function Get-Function { } ``` @@ -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. @@ -155,6 +155,7 @@ For example: #> + function Get-Function { } ``` @@ -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 +# .ExternalHelp function { -# ... - + ... } ``` From 43b23dee65188bbf578685c4a24ec619e1884c59 Mon Sep 17 00:00:00 2001 From: sethvs Date: Fri, 6 Apr 2018 17:56:46 +0300 Subject: [PATCH 2/2] Two more fixes. --- .../About/about_Comment_Based_Help.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index 8a6dbbe15e49..dcdce243b7d4 100644 --- a/reference/6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -165,8 +165,8 @@ or function Get-Function { } <# -.< help keyword> -< help content> +. + #> ```