Skip to content

Commit

Permalink
Fix to align to style guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ArieHein committed Nov 8, 2024
1 parent 1bc513d commit 316dd58
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ The syntax diagrams use the following symbols:

The placeholder inside the angle brackets identifies the .NET type of the
value that a parameter takes. For example, to use the **Name** parameter of
the `Get-Command ` cmdlet, you replace the `<string[]>` with one or more
the `Get-Command` cmdlet, you replace the `<string[]>` with one or more
strings separated by commas (`,`).

<!-- `[]` - also known as binkies -->
Expand Down
1 change: 0 additions & 1 deletion reference/7.5/Microsoft.PowerShell.Core/About/about_If.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,6 @@ $service.Status -eq 'Running' ? (Stop-Service $service) : (Start-Service $servic
In this example, if the service is running, it's stopped, and if its status is
not **Running**, it's started.


If a `<condition>`, `<if-true>`, or `<if-false>` expression calls a command,
you must wrap it in parentheses. If you don't, PowerShell raises an argument
exception for the command in the `<condition>` expression and parsing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The following examples are based on the current working directory being set to
When using a path in a command, you can use a fully qualified path or a
relative one. For example, suppose that your current working directory is
`C:\Windows`. The following `Get-ChildItem` command retrieves all items in the
`C:\TechDocs `directory:
`C:\TechDocs` directory:

```powershell
Get-ChildItem \TechDocs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ drive:\location\child-location\...
```

For example, to change your location to the `HKLM\Software` registry key, type
a `Set-Location `command, such as:
a `Set-Location` command, such as:

```powershell
Set-Location HKLM:\SOFTWARE\
Expand Down
8 changes: 4 additions & 4 deletions reference/7.5/Microsoft.PowerShell.Core/About/about_Ref.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ of a variable that is passed to it.

## Long description

You can pass variables to functions *by reference* or *by value*.
You can pass variables to functions _by reference_ or _by value_.

When you pass a variable *by value*, you are passing a copy of the data.
When you pass a variable _by value_, you are passing a copy of the data.

In the following example, the function changes the value of the variable passed
to it. In PowerShell, integers are value types so they are passed by value.
Expand All @@ -41,9 +41,9 @@ $var

In the following example, a variable containing a `Hashtable` is passed to a
function. `Hashtable` is an object type so by default it is passed to the
function *by reference*.
function _by reference_.

When passing a variable *by reference*, the function can change the data and
When passing a variable _by reference_, the function can change the data and
that change persists after the function executes.

```powershell
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ policy. The policy is set for the default scope, `LocalMachine`.
The `Get-ExecutionPolicy` cmdlet shows that `RemoteSigned` is the effective execution policy for
the current PowerShell session.

The `Start-ActivityTracker.ps1 script is executed from the current directory. The script is blocked
The `Start-ActivityTracker.ps1` script is executed from the current directory. The script is blocked
by `RemoteSigned` because the script isn't digitally signed.

For this example, the script's code was reviewed and verified as safe to run. The `Unblock-File`
Expand Down
8 changes: 4 additions & 4 deletions reference/7.5/Microsoft.PowerShell.Utility/Measure-Object.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Property : num
### Example 11: Measure the Standard Deviation

Beginning in PowerShell 6, `Measure-Object` supports the `-StandardDeviation` parameter. The
following example determines the *standard deviation* for the CPU used by all processes. A large
following example determines the _standard deviation_ for the CPU used by all processes. A large
deviation would indicate a small number of processes consuming the most CPU.

```powershell
Expand Down Expand Up @@ -344,7 +344,7 @@ Accept wildcard characters: False
Indicates that the cmdlet counts the number of characters in the input objects.
> [!NOTE]
> The **Word**, **Char** and **Line** switches count *inside* each input object, as well as *across*
> The **Word**, **Char** and **Line** switches count _inside_ each input object, as well as _across_
> input objects. See Example 7.
```yaml
Expand Down Expand Up @@ -404,7 +404,7 @@ Accept wildcard characters: False
Indicates that the cmdlet counts the number of lines in the input objects.

> [!NOTE]
> The **Word**, **Char** and **Line** switches count *inside* each input object, as well as *across*
> The **Word**, **Char** and **Line** switches count _inside_ each input object, as well as _across_
> input objects. See Example 7.

```yaml
Expand Down Expand Up @@ -509,7 +509,7 @@ Accept wildcard characters: False
Indicates that the cmdlet counts the number of words in the input objects.

> [!NOTE]
> The **Word**, **Char** and **Line** switches count *inside* each input object, as well as *across*
> The **Word**, **Char** and **Line** switches count _inside_ each input object, as well as _across_
> input objects. See Example 7.

```yaml
Expand Down
2 changes: 1 addition & 1 deletion reference/7.5/Microsoft.PowerShell.Utility/Out-String.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ parameter to find matches for the text **gcm**.
> If you omit the **Stream** parameter, the command displays all the aliases because `Select-String`
> finds the text **gcm** in the single string that `Out-String` returns.
### Example 3: Use the Width parameter to prevent truncation.
### Example 3: Use the Width parameter to prevent truncation

While most output from `Out-String` is wrapped to the next line, there are scenarios where the
output is truncated by the formatting system before being passed to `Out-String`. You can avoid
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ line 13.
In this example, the `Wait-Debugger` command was inserted in the `CopyFile` method of a DSC
resource. This is similar to using `Enable-RunspaceDebug -BreakAll` in a DSC resource but breaks at
a specific point in the script.

```
[DscResource()]
class FileResource
Expand Down

0 comments on commit 316dd58

Please sign in to comment.