Closes #1582 - style cleanup (#4887)

* Closes #1582 - style cleanup

* feedback edits

Author: sdwheeler

reference/3.0/Microsoft.PowerShell.Core/About/about_Prompts.md

@@ -1,71 +1,70 @@
 ---
-ms.date:  11/30/2017
+ms.date:  10/04/2019
 schema:  2.0.0
 locale:  en-us
 keywords:  powershell,cmdlet
 title:  about_Prompts
 ---
 # About Prompts
 
-## SHORT DESCRIPTION
+## Short description
+Describes the `Prompt` function and demonstrates how to create a custom
+`Prompt` function.
 
-Describes the Prompt function and demonstrates how to create a custom Prompt
-function.
-
-## LONG DESCRIPTION
+## Long description
 
 The PowerShell command prompt indicates that PowerShell is ready to run a
 command:
 
 ```
-PS>
+PS C:\>
 ```
 
-The PowerShell prompt is determined by the built-in Prompt function. You can
-customize the prompt by creating your own Prompt function and saving it in
+The PowerShell prompt is determined by the built-in `Prompt` function. You can
+customize the prompt by creating your own `Prompt` function and saving it in
 your PowerShell profile.
 
-## ABOUT THE PROMPT FUNCTION
+## About the Prompt function
 
-The Prompt function determines the appearance of the PowerShell prompt.
-PowerShell comes with a built-in Prompt function, but you can override it by
-defining your own Prompt function.
+The `Prompt` function determines the appearance of the PowerShell prompt.
+PowerShell comes with a built-in `Prompt` function, but you can override it by
+defining your own `Prompt` function.
 
-The Prompt function has the following syntax:
+The `Prompt` function has the following syntax:
 
 ```powershell
 function Prompt { <function-body> }
 ```
 
-The Prompt function must return an object. As a best practice, return a string
-or an object that is formatted as a string. The maximum recommended length is
-80 characters.
+The `Prompt` function must return an object. As a best practice, return a
+string or an object that is formatted as a string. The maximum recommended
+length is 80 characters.
 
-For example, the following prompt function returns a "Hello, World" string
-followed by a caret (>).
+For example, the following `Prompt` function returns a "Hello, World" string
+followed by a  right angle bracket (`>`).
 
 ```powershell
-PS> function prompt {"Hello, World > "}
+PS C:\> function prompt {"Hello, World > "}
 Hello, World >
 ```
 
-### GETTING THE PROMPT FUNCTION
+### Getting the Prompt function
 
-To get the Prompt function, use the `Get-Command` cmdlet or use the `Get-Item`
-cmdlet in the Function drive.
+To get the `Prompt` function, use the `Get-Command` cmdlet or use the
+`Get-Item` cmdlet in the Function drive.
 
 For example:
 
 ```powershell
-PS> Get-Command Prompt
+PS C:\> Get-Command Prompt
 
 CommandType     Name      ModuleName
 -----------     ----      ----------
 Function        prompt
 ```
 
 To get the script that sets the value of the prompt, use the dot method to get
-the ScriptBlock property of the Prompt function.
+the **ScriptBlock** property of the `Prompt` function.
 
 For example:
 
@@ -80,68 +79,67 @@ For example:
 # .ExternalHelp System.Management.Automation.dll-help.xml
 ```
 
-Like all functions, the Prompt function is stored in the Function: drive. To
-display the script that creates the current Prompt function, type:
+Like all functions, the `Prompt` function is stored in the `Function:` drive.
+To display the script that creates the current `Prompt` function, type:
 
 ```powershell
 (Get-Item function:prompt).ScriptBlock
 ```
 
+### The default prompt
 
-### THE DEFAULT PROMPT
-
-The default prompt appears only when the Prompt function generates an error or
-does not return an object.
+The default prompt appears only when the `Prompt` function generates an error
+or does not return an object.
 
 The default PowerShell prompt is:
 
 ```
 PS>
 ```
 
-For example, the following command sets the Prompt function to `$null`, which is
-invalid. As a result, the default prompt appears.
+For example, the following command sets the `Prompt` function to `$null`, which
+is invalid. As a result, the default prompt appears.
 
 ```powershell
-PS> function prompt {$null}
+PS C:\> function prompt {$null}
 PS>
 ```
 
 Because PowerShell comes with a built-in prompt, you usually do not see the
 default prompt.
 
-### BUILT-IN PROMPT
+### Built-in prompt
 
-PowerShell includes a built-in prompt function.
+PowerShell includes a built-in `Prompt` function.
 
 ```powershell
 function prompt {
     $(if (Test-Path variable:/PSDebugContext) { '[DBG]: ' }
-    else { '' }) + 'PS ' + $(Get-Location) `
-    + $(if ($nestedpromptlevel -ge 1) { '>>' }) + '> '
+      else { '' }) + 'PS ' + $(Get-Location) +
+        $(if ($NestedPromptLevel -ge 1) { '>>' }) + '> '
 }
 ```
 
-The function uses the Test-Path cmdlet to determine whether the
+The function uses the `Test-Path` cmdlet to determine whether the
 `$PSDebugContext` automatic variable is populated. If `$PSDebugContext` is
-populated, you are in debugging mode, and "[DBG]" is added to the prompt, as
+populated, you are in debugging mode, and `[DBG]:` is added to the prompt, as
 follows:
 
 ```Output
-[DBG] PS C:\ps-test>
+[DBG]: PS C:\ps-test>
 ```
 
-If `$PSDebugContext` is not populated, the function adds "PS" to the prompt.
-And, the function uses the `Get-Location` cmdlet to get the current file
-system directory location. Then, it adds a right angle bracket (>).
+If `$PSDebugContext` is not populated, the function adds `PS` to the prompt.
+And, the function uses the `Get-Location` cmdlet to get the current file system
+directory location. Then, it adds a right angle bracket (`>`).
 
 For example:
 
 ```Output
 PS C:\ps-test>
 ```
 
-If you are in a nested prompt, the function adds two angle brackets (>>) to
+If you are in a nested prompt, the function adds two angle brackets (`>>`) to
 the prompt. (You are in a nested prompt if the value of the
 `$NestedPromptLevel` automatic variable is greater than 1.)
 
@@ -152,10 +150,10 @@ the following prompt:
 [DBG] PS C:\ps-test>>>
 ```
 
-### CHANGES TO THE PROMPT
+### Changes to the prompt
 
-The Enter-PSSession cmdlet prepends the name of the remote computer to the
-current Prompt function. When you use the Enter-PSSession cmdlet to start a
+The `Enter-PSSession` cmdlet prepends the name of the remote computer to the
+current `Prompt` function. When you use the `Enter-PSSession` cmdlet to start a
 session with a remote computer, the command prompt changes to include the name
 of the remote computer. For example:
 
@@ -170,12 +168,12 @@ custom command prompts.
 For more information about the `$PSDebugContext` and `$NestedPromptLevel`
 automatic variables, see [about_Automatic_Variables](about_Automatic_Variables.md).
 
-### HOW TO CUSTOMIZE THE PROMPT
+### How to customize the prompt
 
-To customize the prompt, write a new Prompt function. The function is not
+To customize the prompt, write a new `Prompt` function. The function is not
 protected, so you can overwrite it.
 
-To write a prompt function, type the following:
+To write a `Prompt` function, type the following:
 
 ```powershell
 function prompt { }
@@ -196,7 +194,7 @@ On the Server01 computer, the prompt resembles the following prompt:
 PS [Server01] >
 ```
 
-The following prompt function includes the current date and time:
+The following `Prompt` function includes the current date and time:
 
 ```powershell
 function prompt {"$(Get-Date)> "}
@@ -208,11 +206,11 @@ The prompt resembles the following prompt:
 03/15/2012 17:49:47>
 ```
 
-You can also change the default Prompt function:
+You can also change the default `Prompt` function:
 
-For example, the following modified Prompt function adds "[ADMIN]:" to the
-built-in PowerShell prompt when PowerShell is opened by using the "Run as
-administrator" option:
+For example, the following modified `Prompt` function adds `[ADMIN]:` to the
+built-in PowerShell prompt when PowerShell is opened by using the
+**Run as administrator** option:
 
 ```powershell
 function prompt {
@@ -224,18 +222,18 @@ function prompt {
       "Administrator")) { "[ADMIN]: " }
     else { '' }
   ) + 'PS ' + $(Get-Location) +
-    $(if ($nestedpromptlevel -ge 1) { '>>' }) + '> '
+    $(if ($NestedPromptLevel -ge 1) { '>>' }) + '> '
 }
 ```
 
-When you start PowerShell by using the "Run as administrator" option, a prompt
-that resembles the following prompt appears:
+When you start PowerShell by using the **Run as administrator** option, a
+prompt that resembles the following prompt appears:
 
 ```Output
 [ADMIN]: PS C:\ps-test>
 ```
 
-The following Prompt function displays the history ID of the next command. To
+The following `Prompt` function displays the history ID of the next command. To
 view the command history, use the `Get-History` cmdlet.
 
 ```powershell
@@ -254,27 +252,27 @@ function prompt {
 }
 ```
 
-The following prompt uses the Write-Host and Get-Random cmdlets to create a
+The following prompt uses the `Write-Host` and `Get-Random` cmdlets to create a
 prompt that changes color randomly. Because `Write-Host` writes to the current
 host application but does not return an object, this function includes a
-Return statement. Without it, PowerShell uses the default prompt, "PS>".
+`Return` statement. Without it, PowerShell uses the default prompt, `PS>`.
 
 ```powershell
 function prompt {
-    $color = Get-Random -Minimum 1 -Maximum 16
-    Write-Host ("PS " + $(Get-Location) +">") -NoNewline `
+    $color = Get-Random -Min 1 -Max 16
+    Write-Host ("PS " + $(Get-Location) +">") -NoNewLine `
      -ForegroundColor $Color
     return " "
 }
 ```
 
-### SAVING THE PROMPT FUNCTION
+### Saving the Prompt function
 
-Like any function, the Prompt function exists only in the current session. To
-save the Prompt function for future sessions, add it to your PowerShell
-profiles. For more information about profiles, see about_Profiles.
+Like any function, the `Prompt` function exists only in the current session. To
+save the `Prompt` function for future sessions, add it to your PowerShell
+profiles. For more information about profiles, see [about_Profiles](about_Profiles.md).
 
-## SEE ALSO
+## See also
 
 [Get-Location](../../Microsoft.PowerShell.Management/Get-Location.md)
 
@@ -294,4 +292,4 @@ profiles. For more information about profiles, see about_Profiles.
 
 [about_Debuggers](about_Debuggers.md)
 
-[about_Automatic_Variables](about_Automatic_Variables.md)
+[about_Automatic_Variables](about_Automatic_Variables.md)