Skip to content

Conversation

@alexandair
Copy link
Contributor

@alexandair alexandair commented Aug 1, 2018

Change a description for the Width parameter.
Remove "Windows" from "Windows PowerShell".
Simplify prompt to PS>.
Change a formatting of cmdlet, variable, parameter, and property names.
Use semantic line breaks.
Fix fenced code blocks.

Version(s) of document impacted

  • Impacts 6.1 document
  • Impacts 6.0 document
  • Impacts 5.1 document
  • Impacts 5.0 document
  • Impacts 4.0 document
  • Impacts 3.0 document

Reason(s) for not updating all version of documents

  • The documented feature was introduced in version (list version here) of PowerShell
  • This issue only shows up in version (list version(s) here) of the document
  • This PR partially fixes the issue, and issue # tracks the remaining work

@zjalexander
Copy link
Contributor

❌ Validation status: errors

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Utility/Out-String.md ❌Error Details
❌Error Details

reference/6/Microsoft.PowerShell.Utility/Out-String.md

  • [Error] Unable to load file: 6/Microsoft.PowerShell.Utility/Out-String.md via processor: AzureCliDocumentProcessor: :53:(413) '```powershell
    PS> Out-String -InputObject $C -Wid...'
    Expect Heading

  • [Error] Markdown.MAML.Transformer.HelpSchemaException: :53:(413) '```powershell
    PS> Out-String -InputObject $C -Wid...'
    Expect Heading
    at Microsoft.DocAsCode.Build.Engine.SingleDocumentBuilder.GetInnerContexts(DocumentBuildParameters parameters, IEnumerable1 processors, TemplateProcessor templateProcessor, IHostServiceCreator creator) at Microsoft.DocAsCode.Build.Engine.SingleDocumentBuilder.BuildCore(DocumentBuildParameters parameters) at Microsoft.DocAsCode.Build.Engine.DocumentBuilder.BuildCore(DocumentBuildParameters parameter, IMarkdownServiceProvider markdownServiceProvider, BuildInfo currentBuildInfo, BuildInfo lastBuildInfo) at Microsoft.DocAsCode.Build.Engine.DocumentBuilder.Build(IList1 parameters, String outputDirectory)
    at Microsoft.DocAsCode.SubCommands.DocumentBuilderWrapper.BuildDocument(BuildJsonConfig config, TemplateManager templateManager, String baseDirectory, String outputDirectory, String pluginDirectory, String templateDirectory)
    at Microsoft.DocAsCode.SubCommands.DocumentBuilderWrapper.BuildDocument()

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.

Copy link
Collaborator

@sdwheeler sdwheeler left a comment

Choose a reason for hiding this comment

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

Example #2 breaks the PlatyPS schema. Need to reformat.

Copy link
Contributor

@DCtheGeek DCtheGeek left a comment

Choose a reason for hiding this comment

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

Please make the same changes to 3/4/5.0/6.0 to keep the files consistent.

@zjalexander
Copy link
Contributor

✅ Validation status: passed

File Status Preview URL Details
reference/6/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-6)

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.

@alexandair
Copy link
Contributor Author

@sdwheeler @DCtheGeek

Could you look at the Related Links section? They are not the same for all versions (3.0-6).
Which one is the right one? For example, links in version 6 point to 5.1 help topics.
What are the proper URLs?

Also, this cmdlets could output two different types-- a string and an array of strings (depends of the -Stream parameter). Should that be mentioned in the Outputs section?

@zjalexander
Copy link
Contributor

✅ Validation status: passed

File Status Preview URL Details
reference/3.0/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-3.0)
reference/4.0/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-4.0)
reference/5.0/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-5.0)
reference/5.1/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-5.1)
reference/6/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-6)

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.

@sdwheeler sdwheeler dismissed DCtheGeek’s stale review August 2, 2018 14:54

Requested changed completed

@sdwheeler
Copy link
Collaborator

@alexandair I fixed the related links in this PR. I removed the links to the cmdlets not included in v6. Also, whenever you see fully qualified links like that, you should fix the links to use the relative paths to the file per the style guide.

@zjalexander
Copy link
Contributor

✅ Validation status: passed

File Status Preview URL Details
reference/3.0/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-3.0)
reference/4.0/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-4.0)
reference/5.0/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-5.0)
reference/5.1/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-5.1)
reference/6/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-6)

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.

@zjalexander
Copy link
Contributor

✅ Validation status: passed

File Status Preview URL Details
reference/3.0/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-3.0)
reference/4.0/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-4.0)
reference/5.0/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-5.0)
reference/5.1/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-5.1)
reference/6/Microsoft.PowerShell.Utility/Out-String.md ✅Succeeded View (powershell-6)

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.

@sdwheeler sdwheeler merged commit 1f00b28 into MicrosoftDocs:staging Aug 2, 2018
@alexandair alexandair deleted the outstring6-fix branch August 2, 2018 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants