Fixes #4518 - Added the Assembly parameter to about_Requires (#4879)

* issue 4518

* removed broken links, fixed Output tag

* fixed Assembly parameter description

Author: davidsmatlak

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

@@ -5,17 +5,17 @@ locale:  en-us
 keywords:  powershell,cmdlet
 title:  about_Requires
 ---
+
 # About Requires
 
 ## Short description
 Prevents a script from running without the required elements.
 
 ## Long description
 
-The `#Requires` statement prevents a script from running unless the
-PowerShell version, modules (and version), or snap-ins (and version)
-prerequisites are met. If the prerequisites are not met, PowerShell
-does not run the script.
+The `#Requires` statement prevents a script from running unless the PowerShell
+version, modules (and version), or snap-ins (and version) prerequisites are
+met. If the prerequisites aren't met, PowerShell doesn't run the script.
 
 ### Syntax
 
@@ -48,7 +48,7 @@ Example:
   #Requires -Modules Hyper-V
   ```
 
-You might think that the above code should not run because the required module
+You might think that the above code shouldn't run because the required module
 was removed before the `#Requires` statement. However, the `#Requires` state
 had to be met before the script could even execute. Then the first line of the
 script invalidated the required state.
@@ -82,8 +82,8 @@ For example:
 Specifies PowerShell modules that the script requires. Enter the module name
 and an optional version number.
 
-If the required modules are not in the current session, PowerShell imports
-them. If the modules cannot be imported, PowerShell throws a terminating error.
+If the required modules aren't in the current session, PowerShell imports them.
+If the modules can't be imported, PowerShell throws a terminating error.
 
 For each module, type the module name (\<String\>) or a hash table. The value
 can be a combination of strings and hash tables. The hash table has the
@@ -110,8 +110,9 @@ Require that any version of `PSScheduledJob` and `PSWorkflow` are installed.
 #### -ShellId
 
 Specifies the shell that the script requires. Enter the shell ID. If you use
-the **ShellId** parameter you must also include the **PSSnapin** parameter. You
-can find current ShellId by querying `$ShellId` automatic variable.
+the **ShellId** parameter, you must also include the **PSSnapin** parameter.
+You can find the current **ShellId** by querying the `$ShellId` automatic
+variable.
 
 For example:
 
@@ -121,12 +122,11 @@ For example:
 
 > [!NOTE]
 > This parameter is intended for use in mini-shells, which have been deprecated.
-You can find current ShellId by querying `$ShellId` automatic variable.
 
 ### Examples
 
 The following script has two `#Requires` statements. If the requirements
-specified in both statements are not met, the script does not run. Each
+specified in both statements aren't met, the script doesn't run. Each
 `#Requires` statement must be the first item on a line:
 
 ```powershell
@@ -143,10 +143,10 @@ Param
 
 ### Notes
 
-In Windows PowerShell 3.0, the Windows PowerShell Core packages appear as
-modules in sessions started by using the InitialSessionState.CreateDefault2
-method, such as sessions started in the Windows PowerShell console. Otherwise,
-they appear as snap-ins. The exception is Microsoft.PowerShell.Core, which is
+In Windows PowerShell 3.0, the PowerShell Core packages appear as modules in
+sessions started by using the **InitialSessionState.CreateDefault2** method,
+such as sessions started in the Windows PowerShell console. Otherwise, they
+appear as snap-ins. The exception is `Microsoft.PowerShell.Core`, which is
 always a snap-in.
 
 ## See also

reference/4.0/Microsoft.PowerShell.Core/About/about_Requires.md

@@ -5,17 +5,17 @@ locale:  en-us
 keywords:  powershell,cmdlet
 title:  about_Requires
 ---
+
 # About Requires
 
 ## Short description
 Prevents a script from running without the required elements.
 
 ## Long description
 
-The `#Requires` statement prevents a script from running unless the
-PowerShell version, modules (and version), or snap-ins (and version)
-prerequisites are met. If the prerequisites are not met, PowerShell
-does not run the script.
+The `#Requires` statement prevents a script from running unless the PowerShell
+version, modules (and version), or snap-ins (and version) prerequisites are
+met. If the prerequisites aren't met, PowerShell doesn't run the script.
 
 ### Syntax
 
@@ -49,7 +49,7 @@ Example:
   #Requires -Modules Hyper-V
   ```
 
-You might think that the above code should not run because the required module
+You might think that the above code shouldn't run because the required module
 was removed before the `#Requires` statement. However, the `#Requires` state
 had to be met before the script could even execute. Then the first line of the
 script invalidated the required state.
@@ -83,8 +83,8 @@ For example:
 Specifies PowerShell modules that the script requires. Enter the module name
 and an optional version number.
 
-If the required modules are not in the current session, PowerShell imports
-them. If the modules cannot be imported, PowerShell throws a terminating error.
+If the required modules aren't in the current session, PowerShell imports them.
+If the modules can't be imported, PowerShell throws a terminating error.
 
 For each module, type the module name (\<String\>) or a hash table. The value
 can be a combination of strings and hash tables. The hash table has the
@@ -111,8 +111,9 @@ Require that any version of `PSScheduledJob` and `PSWorkflow` are installed.
 #### -ShellId
 
 Specifies the shell that the script requires. Enter the shell ID. If you use
-the **ShellId** parameter you must also include the **PSSnapin** parameter. You
-can find current ShellId by querying `$ShellId` automatic variable.
+the **ShellId** parameter, you must also include the **PSSnapin** parameter.
+You can find the current **ShellId** by querying the `$ShellId` automatic
+variable.
 
 For example:
 
@@ -139,7 +140,7 @@ For example:
 ### Examples
 
 The following script has two `#Requires` statements. If the requirements
-specified in both statements are not met, the script does not run. Each
+specified in both statements aren't met, the script doesn't run. Each
 `#Requires` statement must be the first item on a line:
 
 ```powershell

reference/5.0/Microsoft.PowerShell.Core/About/about_Requires.md

@@ -5,28 +5,32 @@ locale:  en-us
 keywords:  powershell,cmdlet
 title:  about_Requires
 ---
+
 # About Requires
 
 ## Short description
 Prevents a script from running without the required elements.
 
 ## Long description
 
-The `#Requires` statement prevents a script from running unless the
-PowerShell version, modules (and version), or snap-ins (and version)
-prerequisites are met. If the prerequisites are not met, PowerShell
-does not run the script.
+The `#Requires` statement prevents a script from running unless the PowerShell
+version, modules (and version), or snap-ins (and version) prerequisites are
+met. If the prerequisites aren't met, PowerShell doesn't run the script.
 
 ### Syntax
 
 ```
+#Requires -Assembly { <Path to .dll> | <.NET assembly specification> }
 #Requires -Version <N>[.<n>]
 #Requires -PSSnapin <PSSnapin-Name> [-Version <N>[.<n>]]
 #Requires -Modules { <Module-Name> | <Hashtable> }
 #Requires -ShellId <ShellId> -PSSnapin <PSSnapin-Name> [-Version <N>[.<n>]]
 #Requires -RunAsAdministrator
 ```
 
+For more information about the syntax, see
+[ScriptRequirements](/dotnet/api/system.management.automation.language.scriptrequirements).
+
 ### Rules for use
 
 A script can include more than one `#Requires` statement. The `#Requires`
@@ -49,13 +53,30 @@ Example:
   #Requires -Modules Hyper-V
   ```
 
-You might think that the above code should not run because the required module
+You might think that the above code shouldn't run because the required module
 was removed before the `#Requires` statement. However, the `#Requires` state
 had to be met before the script could even execute. Then the first line of the
 script invalidated the required state.
 
 ### Parameters
 
+#### -Assembly \<Assembly path> | \<.NET assembly specification>
+
+Specifies the path to the assembly DLL file or a .NET assembly name. The
+**Assembly** parameter was introduced in PowerShell 5.0. For more information
+about .NET assemblies, see [Assembly names](/dotnet/standard/assembly/names).
+
+For example:
+
+```
+#Requires -Assembly path\to\foo.dll
+```
+
+```
+#Requires -Assembly "System.Management.Automation, Version=3.0.0.0,
+  Culture=neutral, PublicKeyToken=31bf3856ad364e35"
+```
+
 #### -Version \<N\>[.\<n\>]
 
 Specifies the minimum version of PowerShell that the script requires. Enter a
@@ -83,22 +104,22 @@ For example:
 Specifies PowerShell modules that the script requires. Enter the module name
 and an optional version number.
 
-If the required modules are not in the current session, PowerShell imports
-them. If the modules cannot be imported, PowerShell throws a terminating error.
+If the required modules aren't in the current session, PowerShell imports them.
+If the modules can't be imported, PowerShell throws a terminating error.
 
 For each module, type the module name (\<String\>) or a hash table. The value
 can be a combination of strings and hash tables. The hash table has the
 following keys.
 
 - `ModuleName` - **Required** Specifies the module name.
 - `GUID` - **Optional** Specifies the GUID of the module.
-- It is also **Required** to specify one of the two below keys. These keys
-  cannot be used together.
+- It's also **Required** to specify one of the two below keys. These keys can't
+  be used together.
   - `ModuleVersion` - Specifies a minimum acceptable version of the module.
   - `RequiredVersion` - Specifies an exact, required version of the module.
 
 > [!NOTE]
-> `RequiredVersion` was added in Windows PowerShell 5.0.
+> `RequiredVersion` was added in PowerShell 5.0.
 
 For example:
 
@@ -127,13 +148,14 @@ the version string you wish to require.
 Get-Module Hyper-V
 ```
 
-```output
+```Output
 ModuleType Version    Name     ExportedCommands
 ---------- -------    ----     ------------------
 Binary     2.0.0.0    hyper-v  {Add-VMAssignableDevice, ...}
 ```
 
-This will **FAIL**, because "2.0.0" does not exactly match "2.0.0.0"
+The following example fails because **2.0.0** doesn't exactly match
+**2.0.0.0**.
 
 ```powershell
 #Requires -Modules @{ ModuleName="Hyper-V"; RequiredVersion="2.0.0" }
@@ -142,8 +164,9 @@ This will **FAIL**, because "2.0.0" does not exactly match "2.0.0.0"
 #### -ShellId
 
 Specifies the shell that the script requires. Enter the shell ID. If you use
-the **ShellId** parameter you must also include the **PSSnapin** parameter. You
-can find current ShellId by querying `$ShellId` automatic variable.
+the **ShellId** parameter, you must also include the **PSSnapin** parameter.
+You can find the current **ShellId** by querying the `$ShellId` automatic
+variable.
 
 For example:
 
@@ -156,10 +179,11 @@ For example:
 
 #### -RunAsAdministrator
 
-When this switch parameter is added to your requires statement, it specifies
-that the Windows PowerShell session in which you are running the script must
-be started with elevated user rights (Run as Administrator).
-The RunAsAdministrator parameter is introduced in Windows PowerShell 4.0.
+When this switch parameter is added to your `#Requires` statement, it specifies
+that the PowerShell session in which you're running the script must be started
+with elevated user rights. The **RunAsAdministrator** parameter is ignored on a
+non-Windows operating system. The **RunAsAdministrator** parameter was
+introduced in PowerShell 4.0.
 
 For example:
 
@@ -170,7 +194,7 @@ For example:
 ### Examples
 
 The following script has two `#Requires` statements. If the requirements
-specified in both statements are not met, the script does not run. Each
+specified in both statements aren't met, the script doesn't run. Each
 `#Requires` statement must be the first item on a line:
 
 ```powershell
@@ -193,4 +217,4 @@ Param
 
 [about_PSSnapins](about_PSSnapins.md)
 
-[Get-PSSnapin](../Get-PSSnapin.md)
+[Get-PSSnapin](../Get-PSSnapin.md)