Skip to content

Fixes #3268 short description in about topics #4328

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.

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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
172 changes: 152 additions & 20 deletions reference/6/Microsoft.PowerShell.Core/About/About.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ online version: http://go.microsoft.com/fwlink/?LinkId=834943
# Alias provider

## Provider name

Alias

## Drives
Expand All @@ -20,7 +21,6 @@ Alias
**ShouldProcess**

## Short description

Provides access to the PowerShell aliases and the values that they represent.

## Detailed description
Expand All @@ -45,8 +45,9 @@ in this article.
- [Remove-Item](../../Microsoft.PowerShell.Management/Remove-Item.md)
- [Clear-Item](../../Microsoft.PowerShell.Management/Clear-Item.md)

PowerShell includes a set of cmdlets that are designed to view and to change aliases. When you use **Alias** cmdlets, you do not need to specify the `Alias:` drive in the name. This article does not cover working with
**Alias** cmdlets.
PowerShell includes a set of cmdlets that are designed to view and to change aliases. When you use
**Alias** cmdlets, you do not need to specify the `Alias:` drive in the name. This article does not
cover working with **Alias** cmdlets.

- [Export-Alias](../../Microsoft.PowerShell.Utility/Export-Alias.md)
- [Get-Alias](../../Microsoft.PowerShell.Utility/Get-Alias.md)
Expand Down Expand Up @@ -83,8 +84,8 @@ path.
> PowerShell uses aliases to allow you a familiar way to work with provider
> paths. Commands such as `dir` and `ls` are now aliases for
> [Get-ChildItem](../../Microsoft.PowerShell.Management/Get-ChildItem.md),
> `cd` is an alias for [Set-Location](../../Microsoft.PowerShell.Management/Set-Location.md). and `pwd` is
> an alias for [Get-Location](../../Microsoft.PowerShell.Management/Get-Location.md).
> `cd` is an alias for [Set-Location](../../Microsoft.PowerShell.Management/Set-Location.md). and
> `pwd` is > an alias for [Get-Location](../../Microsoft.PowerShell.Management/Get-Location.md).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrapped improperly.


### Displaying the Contents of the Alias: drive

Expand Down Expand Up @@ -273,8 +274,8 @@ Determines the value of the **Options** property of an alias.

- `None`: No options. This value is the default.
- `Constant`:The alias cannot be deleted and its properties cannot be changed.
`Constant` is available only when you create an alias. You cannot change the option of an existing alias to `Constant`.
- `Private`:The alias is visible only in the current scope, not in the child
`Constant` is available only when you create an alias. You cannot change the option of an existing
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrapped improperly.

alias to `Constant`. - `Private`:The alias is visible only in the current scope, not in the child
scopes.
- `ReadOnly`:The properties of the alias cannot be changed except by using the
`-Force` parameter. You can use `Remove-Item` to delete the alias.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -865,4 +865,4 @@ Default (Current): End

- [about_Hash_Tables](about_Hash_Tables.md)
- [about_Preference_Variables](about_Preference_Variables.md)
- [about_Variables](about_Variables.md)
- [about_Variables](about_Variables.md)
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ represents a connection to a local computer or a remote computer. You can
use CIM sessions as an alternative to PowerShell sessions
(PSSessions). Both approaches have advantages.

You can use the [New-CimSession](../../CimCmdlets/New-CimSession.md) cmdlet to create a CIM session that contains
information about a connection, such as computer name, the protocol used
You can use the [New-CimSession](../../CimCmdlets/New-CimSession.md) cmdlet to create a CIM session
that contains information about a connection, such as computer name, the protocol used
for the connection, session ID, and instance ID.

After you create a CimSession object that specifies information required to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,8 @@ it with a call to [Get-ChildItem](../../Microsoft.PowerShell.Management/Get-Chil
(the alias is "dir"), `Get-Command` or
[Get-Module](../../Microsoft.PowerShell.Core/Get-Module.md).

The call operator executes strings and script blocks in a child scope. For more information, see [about_Operators](about_Operators.md).
The call operator executes strings and script blocks in a child scope. For more information, see
[about_Operators](about_Operators.md).

For example, if you have a function named `Map` that is hidden by an alias
named `Map`, use the following command to run the function.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ title: about_CommonParameters
# About CommonParameters

## SHORT DESCRIPTION

Describes the parameters that can be used with any cmdlet.

## LONG DESCRIPTION
Expand Down Expand Up @@ -528,4 +527,4 @@ about_Common_Parameters

[Write-Error](../../Microsoft.PowerShell.Utility/Write-Error.md)

[Write-Verbose](../../Microsoft.PowerShell.Utility/Write-Verbose.md)
[Write-Verbose](../../Microsoft.PowerShell.Utility/Write-Verbose.md)
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,9 @@ PS> 7, 8, 9 -gt 8
```

> [!NOTE]
> This should not to be confused with `>`, the greater-than operator in many other programming languages. In PowerShell, `>` is used for redirection. For more information, see [About_redirection](about_Redirection.md#potential-confusion-with-comparison-operators).
> This should not to be confused with `>`, the greater-than operator in many other programming
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrapped improperly.

> languages. In PowerShell, `>` is used for redirection. For more information, see
[About_redirection](about_Redirection.md#potential-confusion-with-comparison-operators).

#### -ge

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ online version: https://go.microsoft.com/fwlink/?linkid=834944
# Environment provider

## Provider name

Environment

## Drives
Expand All @@ -20,19 +21,21 @@ Environment
**ShouldProcess**

## Short description

Provides access to the Windows environment variables.

## Detailed description

The PowerShell **Environment** provider lets you get, add, change, clear, and delete environment
variables and values in PowerShell.

**Environment** variables are dynamically named variables that describe the environment in which your programs run. Windows and PowerShell use environment variables to store persistent information that affect system
and process execution. Unlike PowerShell variables, environment variables are not subject to scope constraints.
**Environment** variables are dynamically named variables that describe the environment in which
your programs run. Windows and PowerShell use environment variables to store persistent information
that affect system
and process execution. Unlike PowerShell variables, environment variables are not subject to scope
constraints.

The **Environment** drive is a flat namespace containing the environment variables specific to the current user's session. The environment variables
have no child items.
The **Environment** drive is a flat namespace containing the environment variables specific to the
current user's session. The environment variables have no child items.

The **Environment** provider supports the following cmdlets, which are covered
in this article.
Expand Down Expand Up @@ -71,7 +74,8 @@ Set-Location C:
```

You can also work with the **Environment** provider from any other PowerShell
drive. To reference an environment variable from another location, use the drive name `Env:` in the path.
drive. To reference an environment variable from another location, use the drive name `Env:` in the
path.

The **Environment** provider also exposes environment variables using a variable
prefix of `$env:`. The following command views the contents of the
Expand All @@ -91,8 +95,8 @@ session for as long as it is active.
> PowerShell uses aliases to allow you a familiar way to work with provider
> paths. Commands such as `dir` and `ls` are now aliases for
> [Get-ChildItem](../../Microsoft.PowerShell.Management/Get-ChildItem.md),
> `cd` is an alias for [Set-Location](../../Microsoft.PowerShell.Management/Set-Location.md). and `pwd` is
> an alias for [Get-Location](../../Microsoft.PowerShell.Management/Get-Location.md).
> `cd` is an alias for [Set-Location](../../Microsoft.PowerShell.Management/Set-Location.md). and
> `pwd` is > an alias for [Get-Location](../../Microsoft.PowerShell.Management/Get-Location.md).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix the line wrapping.


## Getting environment variables

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,9 @@ locale: en-us
keywords: powershell,cmdlet
title: about_Execution_Policies
---

# About Execution Policies

## Short Description

Describes the PowerShell execution policies and explains how to manage them.

## Long Description
Expand Down Expand Up @@ -368,4 +366,4 @@ and [Unblock-File](../../Microsoft.PowerShell.Utility/Unblock-File.md).

[Set-ExecutionPolicy](../../Microsoft.PowerShell.Security/Set-ExecutionPolicy.md)

[Unblock-File](../../Microsoft.PowerShell.Utility/Unblock-File.md)
[Unblock-File](../../Microsoft.PowerShell.Utility/Unblock-File.md)
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,4 @@ if ([ExperimentalFeature]::IsEnabled("MyExperimentalFeature"))

[Disable-ExperimentalFeature](../Disable-ExperimentalFeature.md)

[Get-ExperimentalFeature](../Get-ExperimentalFeature.md)
[Get-ExperimentalFeature](../Get-ExperimentalFeature.md)
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ online version: http://go.microsoft.com/fwlink/?LinkId=821468
# FileSystem provider

## Provider name

FileSystem

## Drives
Expand All @@ -20,7 +21,6 @@ FileSystem
**Filter**, **ShouldProcess**

## Short description

Provides access to files and directories.

## Detailed description
Expand Down Expand Up @@ -56,8 +56,8 @@ in this article.

## Types exposed by this provider

Files are instances of the [System.IO.FileInfo](/dotnet/api/system.io.fileinfo) class. Directories are
instances of the [System.IO.DirectoryInfo](/dotnet/api/system.io.directoryinfo) class.
Files are instances of the [System.IO.FileInfo](/dotnet/api/system.io.fileinfo) class. Directories
are instances of the [System.IO.DirectoryInfo](/dotnet/api/system.io.directoryinfo) class.

## Navigating the FileSystem drives

Expand All @@ -71,14 +71,15 @@ Set-Location C:
```

You can also work with the **FileSystem** provider from any other PowerShell
drive. To reference a file or directory from another location, use the drive name (`C:`, `D:`, ...) in the path.
drive. To reference a file or directory from another location, use the drive name (`C:`, `D:`, ...)
in the path.

> [!NOTE]
> PowerShell uses aliases to allow you a familiar way to work with provider
> paths. Commands such as `dir` and `ls` are now aliases for
> [Get-ChildItem](../../Microsoft.PowerShell.Management/Get-ChildItem.md),
> `cd` is an alias for [Set-Location](../../Microsoft.PowerShell.Management/Set-Location.md). and `pwd` is
> an alias for [Get-Location](../../Microsoft.PowerShell.Management/Get-Location.md).
> `cd` is an alias for [Set-Location](../../Microsoft.PowerShell.Management/Set-Location.md). and
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix the line wrapping.

> `pwd` is > an alias for [Get-Location](../../Microsoft.PowerShell.Management/Get-Location.md).

## Getting files and directories

Expand Down Expand Up @@ -521,7 +522,8 @@ parameter. To exclude files, use the `-Directory` parameter and omit the

### Hidden \<System.Management.Automation.SwitchParameter\>

Gets only hidden files and directories (folders). By default, [Get-ChildItem](../../Microsoft.PowerShell.Management/Get-ChildItem.md) gets only non-hidden items.
Gets only hidden files and directories (folders). By default, [Get-ChildItem](../../Microsoft.PowerShell.Management/Get-ChildItem.md) gets only non-hidden
items.

The `-Hidden` parameter was introduced in Windows PowerShell 3.0.

Expand Down
2 changes: 1 addition & 1 deletion reference/6/Microsoft.PowerShell.Core/About/about_For.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,4 +233,4 @@ for ($i = 0; $i -lt 10; $i++) { Write-Host $i }

[about_Comparison_Operators](about_Comparison_Operators.md)

[about_Foreach](about_Foreach.md)
[about_Foreach](about_Foreach.md)
Original file line number Diff line number Diff line change
Expand Up @@ -227,4 +227,4 @@ function Get-FunctionPosition {

[about_If](about_If.md)

[ForEach-Object](../ForEach-Object.md)
[ForEach-Object](../ForEach-Object.md)
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ online version: http://go.microsoft.com/fwlink/?LinkId=834961
# Function provider

## Provider name

Function

## Drives
Expand All @@ -20,7 +21,6 @@ Function
**ShouldProcess**

## Short description

Provides access to the functions defined in PowerShell.

## Detailed description
Expand Down Expand Up @@ -80,8 +80,8 @@ drive. To reference an function from another location, use the drive name
> PowerShell uses aliases to allow you a familiar way to work with provider
> paths. Commands such as `dir` and `ls` are now aliases for
> [Get-ChildItem](../../Microsoft.PowerShell.Management/Get-ChildItem.md),
> `cd` is an alias for [Set-Location](../../Microsoft.PowerShell.Management/Set-Location.md). and `pwd` is
> an alias for [Get-Location](../../Microsoft.PowerShell.Management/Get-Location.md).
> `cd` is an alias for [Set-Location](../../Microsoft.PowerShell.Management/Set-Location.md). and
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix the line wrapping.

> `pwd` is > an alias for [Get-Location](../../Microsoft.PowerShell.Management/Get-Location.md).

## Getting functions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -622,4 +622,4 @@ methods:

[about_Script_Blocks](about_Script_Blocks.md)

[about_Function_provider](about_Function_provider.md)
[about_Function_provider](about_Function_provider.md)
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ the following methods:

All the methods and properties of the `PSCmdlet` class are available to
advanced functions. For more information about these methods and properties,
see [`System.Management.Automation.PSCmdlet`](https://go.microsoft.com/fwlink/?LinkId=142139) in the MSDN library.
see [`System.Management.Automation.PSCmdlet`](https://go.microsoft.com/fwlink/?LinkId=142139) in the
MSDN library.

### Input Processing Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ To unregister the PowerShell provider, run the following command from an elevate
$PSHOME\RegisterManifest.ps1 -Unregister
```

After updating PowerShell, run `$PSHOME\RegisterManifest.ps1` to register the updated event provider.
After updating PowerShell, run `$PSHOME\RegisterManifest.ps1` to register the updated event
provider.

## Enabling Script Block Logging

Expand Down