From 6d52633024a2964e953f5d58d60d5dc52266ce4c Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Fri, 9 Aug 2024 09:32:28 -0500 Subject: [PATCH 1/2] Fix typo (#11327) --- .../5.1/Microsoft.PowerShell.Management/Get-ChildItem.md | 4 ++-- .../7.2/Microsoft.PowerShell.Management/Get-ChildItem.md | 4 ++-- .../7.4/Microsoft.PowerShell.Management/Get-ChildItem.md | 4 ++-- .../7.5/Microsoft.PowerShell.Management/Get-ChildItem.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/reference/5.1/Microsoft.PowerShell.Management/Get-ChildItem.md b/reference/5.1/Microsoft.PowerShell.Management/Get-ChildItem.md index 8703d5e5a667..2d2a85723121 100644 --- a/reference/5.1/Microsoft.PowerShell.Management/Get-ChildItem.md +++ b/reference/5.1/Microsoft.PowerShell.Management/Get-ChildItem.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Management -ms.date: 03/28/2024 +ms.date: 08/09/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/get-childitem?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: Get-ChildItem @@ -192,7 +192,7 @@ Mode LastWriteTime Length Name The `Get-ChildItem` cmdlet uses the **Path** parameter to specify `C:\Test\*.txt`. **Path** uses the asterisk (`*`) wildcard to specify all files with the filename extension `.txt`. The **Recurse** -parameter searches the **Path** directory its subdirectories, as shown in the **Directory:** +parameter searches the **Path** directory and its subdirectories, as shown in the **Directory:** headings. The **Force** parameter displays hidden files such as `hiddenfile.txt` that have a mode of **h**. diff --git a/reference/7.2/Microsoft.PowerShell.Management/Get-ChildItem.md b/reference/7.2/Microsoft.PowerShell.Management/Get-ChildItem.md index c0d910321317..d89d9caefec7 100644 --- a/reference/7.2/Microsoft.PowerShell.Management/Get-ChildItem.md +++ b/reference/7.2/Microsoft.PowerShell.Management/Get-ChildItem.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Management -ms.date: 03/28/2024 +ms.date: 08/09/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/get-childitem?view=powershell-7.2&WT.mc_id=ps-gethelp schema: 2.0.0 title: Get-ChildItem @@ -191,7 +191,7 @@ Mode LastWriteTime Length Name The `Get-ChildItem` cmdlet uses the **Path** parameter to specify `C:\Test\*.txt`. **Path** uses the asterisk (`*`) wildcard to specify all files with the filename extension `.txt`. The **Recurse** -parameter searches the **Path** directory its subdirectories, as shown in the **Directory:** +parameter searches the **Path** directory and its subdirectories, as shown in the **Directory:** headings. The **Force** parameter displays hidden files such as `hiddenfile.txt` that have a mode of **h**. diff --git a/reference/7.4/Microsoft.PowerShell.Management/Get-ChildItem.md b/reference/7.4/Microsoft.PowerShell.Management/Get-ChildItem.md index f4efb6dc35cd..033e4783159d 100644 --- a/reference/7.4/Microsoft.PowerShell.Management/Get-ChildItem.md +++ b/reference/7.4/Microsoft.PowerShell.Management/Get-ChildItem.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Management -ms.date: 03/28/2024 +ms.date: 08/09/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/get-childitem?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: Get-ChildItem @@ -191,7 +191,7 @@ Mode LastWriteTime Length Name The `Get-ChildItem` cmdlet uses the **Path** parameter to specify `C:\Test\*.txt`. **Path** uses the asterisk (`*`) wildcard to specify all files with the filename extension `.txt`. The **Recurse** -parameter searches the **Path** directory its subdirectories, as shown in the **Directory:** +parameter searches the **Path** directory and its subdirectories, as shown in the **Directory:** headings. The **Force** parameter displays hidden files such as `hiddenfile.txt` that have a mode of **h**. diff --git a/reference/7.5/Microsoft.PowerShell.Management/Get-ChildItem.md b/reference/7.5/Microsoft.PowerShell.Management/Get-ChildItem.md index 6bcfc4643aa9..7ea98df8fbdd 100644 --- a/reference/7.5/Microsoft.PowerShell.Management/Get-ChildItem.md +++ b/reference/7.5/Microsoft.PowerShell.Management/Get-ChildItem.md @@ -2,7 +2,7 @@ external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml Locale: en-US Module Name: Microsoft.PowerShell.Management -ms.date: 03/28/2024 +ms.date: 08/09/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.management/get-childitem?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: Get-ChildItem @@ -191,7 +191,7 @@ Mode LastWriteTime Length Name The `Get-ChildItem` cmdlet uses the **Path** parameter to specify `C:\Test\*.txt`. **Path** uses the asterisk (`*`) wildcard to specify all files with the filename extension `.txt`. The **Recurse** -parameter searches the **Path** directory its subdirectories, as shown in the **Directory:** +parameter searches the **Path** directory and its subdirectories, as shown in the **Directory:** headings. The **Force** parameter displays hidden files such as `hiddenfile.txt` that have a mode of **h**. From 2422d900672fe9838ffebade91d03cb09618864d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guillermo=20L=C3=B3pez-Anglada?= Date: Fri, 9 Aug 2024 16:52:46 +0200 Subject: [PATCH 2/2] Add details to 'about_Modules' topic (#11276) * Add details to 'about_Modules' topic * Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) * Minor edits and copy to all versions --------- Co-authored-by: Sean Wheeler Co-authored-by: Mikey Lombardi (He/Him) --- .../About/about_Modules.md | 49 ++++++++++--------- .../About/about_Modules.md | 49 ++++++++++--------- .../About/about_Modules.md | 49 ++++++++++--------- .../About/about_Modules.md | 49 ++++++++++--------- 4 files changed, 108 insertions(+), 88 deletions(-) diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/about_Modules.md b/reference/5.1/Microsoft.PowerShell.Core/About/about_Modules.md index ef2427c8306a..b63d5c2cd409 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/about_Modules.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/about_Modules.md @@ -1,7 +1,7 @@ --- description: Explains how to install, import, and use PowerShell modules. Locale: en-US -ms.date: 03/18/2024 +ms.date: 08/09/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_modules?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: about Modules @@ -13,29 +13,34 @@ Explains how to install, import, and use PowerShell modules. ## Long description -PowerShell is a scripting language and a command shell. The language is -comprised of [keywords][07], which provide the structure and logic of -processing, and commands that perform the work. Commands in PowerShell are -implemented as scripts, functions, or cmdlets. +PowerShell is both a command shell and a scripting language. Commands in +PowerShell are implemented as scripts, functions, or cmdlets. The language +includes [keywords][07], which provide the structure and logic of processing, +and other resources, such as variables, providers, aliases. -A module is a self-contained reusable unit that can contain cmdlets, providers, -functions, variables, and other types of resources that can be imported as a -single unit. +A module is a self-contained, reusable unit that can include cmdlets, providers, +functions, variables, and other resources that can be imported into a PowerShell +session or any custom PowerShell program. -PowerShell comes with a base set of modules. You can also install more modules -as needed. By default, installed modules are loaded automatically the first -time you use a command from a module. Use the `$PSModuleAutoloadingPreference` -variable to enable, disable and configure automatic loading of modules. For -more information, see [about_Preference_Variables][08]. +Before the functionality contained in a module is usable, the module must be +loaded into the PowerShell session. By default, PowerShell automatically loads +an installed module the first time you use a command from the module. You can +configure automatic module loading behavior using the variable +`$PSModuleAutoloadingPreference`. For more information, see +[about_Preference_Variables][08]. -You can unload or reload during a session. Use the `Remove-Module` cmdlet to -unload a module from your session. Use the `Import-Module` cmdlet to load a -module. +You can also manually unload or reload modules during a PowerShell session. To +unload a module, use the `Remove-Module` cmdlet. To load or reload a module, +use `Import-Module`. -Modules can be created as compiled .NET assemblies written in C#, or -script-based modules written in PowerShell. This topic explains how to use -PowerShell modules. For information about how to write PowerShell modules, see -[Writing a PowerShell Module][02]. +PowerShell comes with a base set of modules. Anyone can create new PowerShell +commands or other resources, and publish them as modules that users can install +as needed. + +You can write modules in C# as compiled .NET assemblies, known as native +modules, or in plain PowerShell, known as script modules. This topic explains +how to use PowerShell modules. For information about how to create PowerShell +modules, see [Writing a PowerShell Module][02]. > [!NOTE] > Prior to PowerShell 3.0, cmdlets and providers were packaged in PowerShell @@ -92,8 +97,8 @@ Use the following command to create a `Modules` folder for the current user: $folder = New-Item -Type Directory -Path $HOME\Documents\WindowsPowerShell\Modules ``` -Copy the entire module folder into the new created folder. In PowerShell use the -`Copy-Item` cmdlet. For example, run the following command to copy the +Copy the entire module folder into the new created folder. In PowerShell use +the `Copy-Item` cmdlet. For example, run the following command to copy the `MyModule` folder from `C:\PSTest` to the folder you just created: ```powershell diff --git a/reference/7.2/Microsoft.PowerShell.Core/About/about_Modules.md b/reference/7.2/Microsoft.PowerShell.Core/About/about_Modules.md index 428c38665aa8..d2e568719952 100644 --- a/reference/7.2/Microsoft.PowerShell.Core/About/about_Modules.md +++ b/reference/7.2/Microsoft.PowerShell.Core/About/about_Modules.md @@ -1,7 +1,7 @@ --- description: Explains how to install, import, and use PowerShell modules. Locale: en-US -ms.date: 03/18/2024 +ms.date: 08/09/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_modules?view=powershell-7.2&WT.mc_id=ps-gethelp schema: 2.0.0 title: about Modules @@ -13,29 +13,34 @@ Explains how to install, import, and use PowerShell modules. ## Long description -PowerShell is a scripting language and a command shell. The language is -comprised of [keywords][07], which provide the structure and logic of -processing, and commands that perform the work. Commands in PowerShell are -implemented as scripts, functions, or cmdlets. +PowerShell is both a command shell and a scripting language. Commands in +PowerShell are implemented as scripts, functions, or cmdlets. The language +includes [keywords][07], which provide the structure and logic of processing, +and other resources, such as variables, providers, aliases. -A module is a self-contained reusable unit that can contain cmdlets, providers, -functions, variables, and other types of resources that can be imported as a -single unit. +A module is a self-contained, reusable unit that can include cmdlets, providers, +functions, variables, and other resources that can be imported into a PowerShell +session or any custom PowerShell program. -PowerShell comes with a base set of modules. You can also install more modules -as needed. By default, installed modules are loaded automatically the first -time you use a command from a module. Use the `$PSModuleAutoloadingPreference` -variable to enable, disable and configure automatic loading of modules. For -more information, see [about_Preference_Variables][08]. +Before the functionality contained in a module is usable, the module must be +loaded into the PowerShell session. By default, PowerShell automatically loads +an installed module the first time you use a command from the module. You can +configure automatic module loading behavior using the variable +`$PSModuleAutoloadingPreference`. For more information, see +[about_Preference_Variables][08]. -You can unload or reload during a session. Use the `Remove-Module` cmdlet to -unload a module from your session. Use the `Import-Module` cmdlet to load a -module. +You can also manually unload or reload modules during a PowerShell session. To +unload a module, use the `Remove-Module` cmdlet. To load or reload a module, +use `Import-Module`. -Modules can be created as compiled .NET assemblies written in C#, or -script-based modules written in PowerShell. This topic explains how to use -PowerShell modules. For information about how to write PowerShell modules, see -[Writing a PowerShell Module][02]. +PowerShell comes with a base set of modules. Anyone can create new PowerShell +commands or other resources, and publish them as modules that users can install +as needed. + +You can write modules in C# as compiled .NET assemblies, known as native +modules, or in plain PowerShell, known as script modules. This topic explains +how to use PowerShell modules. For information about how to create PowerShell +modules, see [Writing a PowerShell Module][02]. > [!NOTE] > Prior to PowerShell 3.0, cmdlets and providers were packaged in PowerShell @@ -92,8 +97,8 @@ Use the following command to create a `Modules` folder for the current user: $folder = New-Item -Type Directory -Path $HOME\Documents\PowerShell\Modules ``` -Copy the entire module folder into the new created folder. In PowerShell use the -`Copy-Item` cmdlet. For example, run the following command to copy the +Copy the entire module folder into the new created folder. In PowerShell use +the `Copy-Item` cmdlet. For example, run the following command to copy the `MyModule` folder from `C:\PSTest` to the folder you just created: ```powershell diff --git a/reference/7.4/Microsoft.PowerShell.Core/About/about_Modules.md b/reference/7.4/Microsoft.PowerShell.Core/About/about_Modules.md index 4c2e6ba932ec..a599c55d5ed9 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/About/about_Modules.md +++ b/reference/7.4/Microsoft.PowerShell.Core/About/about_Modules.md @@ -1,7 +1,7 @@ --- description: Explains how to install, import, and use PowerShell modules. Locale: en-US -ms.date: 03/18/2024 +ms.date: 08/09/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_modules?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: about Modules @@ -13,29 +13,34 @@ Explains how to install, import, and use PowerShell modules. ## Long description -PowerShell is a scripting language and a command shell. The language is -comprised of [keywords][07], which provide the structure and logic of -processing, and commands that perform the work. Commands in PowerShell are -implemented as scripts, functions, or cmdlets. +PowerShell is both a command shell and a scripting language. Commands in +PowerShell are implemented as scripts, functions, or cmdlets. The language +includes [keywords][07], which provide the structure and logic of processing, +and other resources, such as variables, providers, aliases. -A module is a self-contained reusable unit that can contain cmdlets, providers, -functions, variables, and other types of resources that can be imported as a -single unit. +A module is a self-contained, reusable unit that can include cmdlets, providers, +functions, variables, and other resources that can be imported into a PowerShell +session or any custom PowerShell program. -PowerShell comes with a base set of modules. You can also install more modules -as needed. By default, installed modules are loaded automatically the first -time you use a command from a module. Use the `$PSModuleAutoloadingPreference` -variable to enable, disable and configure automatic loading of modules. For -more information, see [about_Preference_Variables][08]. +Before the functionality contained in a module is usable, the module must be +loaded into the PowerShell session. By default, PowerShell automatically loads +an installed module the first time you use a command from the module. You can +configure automatic module loading behavior using the variable +`$PSModuleAutoloadingPreference`. For more information, see +[about_Preference_Variables][08]. -You can unload or reload during a session. Use the `Remove-Module` cmdlet to -unload a module from your session. Use the `Import-Module` cmdlet to load a -module. +You can also manually unload or reload modules during a PowerShell session. To +unload a module, use the `Remove-Module` cmdlet. To load or reload a module, +use `Import-Module`. -Modules can be created as compiled .NET assemblies written in C#, or -script-based modules written in PowerShell. This topic explains how to use -PowerShell modules. For information about how to write PowerShell modules, see -[Writing a PowerShell Module][02]. +PowerShell comes with a base set of modules. Anyone can create new PowerShell +commands or other resources, and publish them as modules that users can install +as needed. + +You can write modules in C# as compiled .NET assemblies, known as native +modules, or in plain PowerShell, known as script modules. This topic explains +how to use PowerShell modules. For information about how to create PowerShell +modules, see [Writing a PowerShell Module][02]. > [!NOTE] > Prior to PowerShell 3.0, cmdlets and providers were packaged in PowerShell @@ -92,8 +97,8 @@ Use the following command to create a `Modules` folder for the current user: $folder = New-Item -Type Directory -Path $HOME\Documents\PowerShell\Modules ``` -Copy the entire module folder into the new created folder. In PowerShell use the -`Copy-Item` cmdlet. For example, run the following command to copy the +Copy the entire module folder into the new created folder. In PowerShell use +the `Copy-Item` cmdlet. For example, run the following command to copy the `MyModule` folder from `C:\PSTest` to the folder you just created: ```powershell diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Modules.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Modules.md index 0c62fe424b04..b0efea28a034 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Modules.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Modules.md @@ -1,7 +1,7 @@ --- description: Explains how to install, import, and use PowerShell modules. Locale: en-US -ms.date: 03/18/2024 +ms.date: 08/09/2024 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_modules?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: about Modules @@ -13,29 +13,34 @@ Explains how to install, import, and use PowerShell modules. ## Long description -PowerShell is a scripting language and a command shell. The language is -comprised of [keywords][07], which provide the structure and logic of -processing, and commands that perform the work. Commands in PowerShell are -implemented as scripts, functions, or cmdlets. +PowerShell is both a command shell and a scripting language. Commands in +PowerShell are implemented as scripts, functions, or cmdlets. The language +includes [keywords][07], which provide the structure and logic of processing, +and other resources, such as variables, providers, aliases. -A module is a self-contained reusable unit that can contain cmdlets, providers, -functions, variables, and other types of resources that can be imported as a -single unit. +A module is a self-contained, reusable unit that can include cmdlets, providers, +functions, variables, and other resources that can be imported into a PowerShell +session or any custom PowerShell program. -PowerShell comes with a base set of modules. You can also install more modules -as needed. By default, installed modules are loaded automatically the first -time you use a command from a module. Use the `$PSModuleAutoloadingPreference` -variable to enable, disable and configure automatic loading of modules. For -more information, see [about_Preference_Variables][08]. +Before the functionality contained in a module is usable, the module must be +loaded into the PowerShell session. By default, PowerShell automatically loads +an installed module the first time you use a command from the module. You can +configure automatic module loading behavior using the variable +`$PSModuleAutoloadingPreference`. For more information, see +[about_Preference_Variables][08]. -You can unload or reload during a session. Use the `Remove-Module` cmdlet to -unload a module from your session. Use the `Import-Module` cmdlet to load a -module. +You can also manually unload or reload modules during a PowerShell session. To +unload a module, use the `Remove-Module` cmdlet. To load or reload a module, +use `Import-Module`. -Modules can be created as compiled .NET assemblies written in C#, or -script-based modules written in PowerShell. This topic explains how to use -PowerShell modules. For information about how to write PowerShell modules, see -[Writing a PowerShell Module][02]. +PowerShell comes with a base set of modules. Anyone can create new PowerShell +commands or other resources, and publish them as modules that users can install +as needed. + +You can write modules in C# as compiled .NET assemblies, known as native +modules, or in plain PowerShell, known as script modules. This topic explains +how to use PowerShell modules. For information about how to create PowerShell +modules, see [Writing a PowerShell Module][02]. > [!NOTE] > Prior to PowerShell 3.0, cmdlets and providers were packaged in PowerShell @@ -92,8 +97,8 @@ Use the following command to create a `Modules` folder for the current user: $folder = New-Item -Type Directory -Path $HOME\Documents\PowerShell\Modules ``` -Copy the entire module folder into the new created folder. In PowerShell use the -`Copy-Item` cmdlet. For example, run the following command to copy the +Copy the entire module folder into the new created folder. In PowerShell use +the `Copy-Item` cmdlet. For example, run the following command to copy the `MyModule` folder from `C:\PSTest` to the folder you just created: ```powershell