Skip to content

Commit

Permalink
Fix note about stream output
Browse files Browse the repository at this point in the history
  • Loading branch information
sdwheeler committed May 20, 2024
1 parent 6a94b1c commit 0cfdf22
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,7 @@ script cmdlet. Resource cleanup is enforced for the following scenarios:
1. when the pipeline is being stopped by <kbd>Ctrl+c</kbd> or
`StopProcessing()`

The clean block doesn't allow pipeline output. Any output that's written to the
pipeline is discarded. Output from `Write-Host` is still sent displayed by the
host process.
The clean block discards any output that's written to the **Success** stream.

> [!CAUTION]
> Adding the `clean` block is a breaking change. Because `clean` is parsed as a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,7 @@ script cmdlet. Resource cleanup is enforced for the following scenarios:
1. when the pipeline is being stopped by <kbd>Ctrl+c</kbd> or
`StopProcessing()`

The clean block doesn't allow pipeline output. Any output that's written to the
pipeline is discarded. Output from `Write-Host` is still sent displayed by the
host process.
The clean block discards any output that's written to the **Success** stream.

> [!CAUTION]
> Adding the `clean` block is a breaking change. Because `clean` is parsed as a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,7 @@ script cmdlet. Resource cleanup is enforced for the following scenarios:
1. when the pipeline is being stopped by <kbd>Ctrl+c</kbd> or
`StopProcessing()`

The clean block doesn't allow pipeline output. Any output that's written to the
pipeline is discarded. Output from `Write-Host` is still sent displayed by the
host process.
The clean block discards any output that's written to the **Success** stream.

> [!CAUTION]
> Adding the `clean` block is a breaking change. Because `clean` is parsed as a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,7 @@ script cmdlet. Resource cleanup is enforced for the following scenarios:
1. when the pipeline is being stopped by <kbd>Ctrl+c</kbd> or
`StopProcessing()`

The clean block doesn't allow pipeline output. Any output that's written to the
pipeline is discarded. Output from `Write-Host` is still sent displayed by the
host process.
The clean block discards any output that's written to the **Success** stream.

> [!CAUTION]
> Adding the `clean` block is a breaking change. Because `clean` is parsed as a
Expand Down

0 comments on commit 0cfdf22

Please sign in to comment.