updating Out-* commands with -NoNewLine per Issue 1739 #1846
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@zjalexander Please review and merge. |
zjalexander
approved these changes
Nov 13, 2017
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
| ``` | ||
|
|
||
| ```powershell | ||
| PS C:\> add-content -path *.txt -exclude help* -value "END" |
There was a problem hiding this comment.
in other versions you cased the examples, but missed these.
|
|
||
| Stream is a dynamic parameter that the FileSystem provider adds to the Add-Content cmdlet. This parameter works only in file system drives. | ||
| Adds the content to the specified alternate data stream. If the stream does not yet, exist, Add-Content creates it. |
There was a problem hiding this comment.
missed some semantic linebreaks here
| Specifies the path to the output file. | ||
| Unlike **FilePath**, the value of the **LiteralPath** parameter is used exactly as it is typed. | ||
| Unlike *FilePath*, the value of the *LiteralPath* parameter is used exactly as it is typed. |
There was a problem hiding this comment.
In the style guide, we have the following:
Property names and parameter names should be in bold
| Add-Content [-Value] <Object[]> [-PassThru] -LiteralPath <String[]> [-Filter <String>] [-Include <String[]>] | ||
| [-Exclude <String[]>] [-Force] [-Credential <PSCredential>] [-WhatIf] [-Confirm] [-UseTransaction] | ||
| [-NoNewline] [-Encoding <FileSystemCmdletProviderEncoding>] [-Stream <String>] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
| The **Add-Content** cmdlet appends content to a specified item or file. | ||
|
|
||
| The Add-Content cmdlet appends content to a specified item or file. |
There was a problem hiding this comment.
Again, according to the style guide:
When talking about a cmdlet in paragraph, use ` to highlight cmdlet names
zjalexander
approved these changes
Nov 13, 2017
❌ Validation status: errors
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
updating Out-* commands with -NoNewLine per Issue #1739
Version(s) of document impacted