updating Out-* commands with -NoNewLine per Issue 1739#1846
updating Out-* commands with -NoNewLine per Issue 1739#1846zjalexander merged 3 commits intoMicrosoftDocs:stagingfrom sdwheeler:sdw-issue1739
Conversation
|
@zjalexander Please review and merge. |
zjalexander
left a comment
There was a problem hiding this comment.
sniff I love the smell of cleaned-up documentation in the morning.
There's a few inconsistencies. I'll talk to you about whether it's easier to fix them now or to let them sit for a while.
| ``` | ||
|
|
||
| ```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.
| Adds the content to the specified alternate data stream. If the stream does not yet, exist, Add-Content creates it. Enter the stream name. Wildcards are not supported. | ||
|
|
||
| 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
| ## 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
❌ 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. |
updating Out-* commands with -NoNewLine per Issue #1739
Version(s) of document impacted