Skip to content

(AB-538621) Extend Write-Host note for non-primitive types#12913

Merged
sdwheeler merged 1 commit intoMicrosoftDocs:mainfrom
michaeltlombardi:ab-538621/main/write-host-formatting
Apr 1, 2026
Merged

(AB-538621) Extend Write-Host note for non-primitive types#12913
sdwheeler merged 1 commit intoMicrosoftDocs:mainfrom
michaeltlombardi:ab-538621/main/write-host-formatting

Conversation

@michaeltlombardi
Copy link
Copy Markdown
Contributor

@michaeltlombardi michaeltlombardi commented Apr 1, 2026

PR Summary

This PR fixes AB#538621 by extending the note about Write-Host having unexpected / not-useful output for objects by recommending approaches and showing a short example.

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributor's guide.
  • Style: This PR adheres to the style guide.

Copilot AI review requested due to automatic review settings April 1, 2026 16:13
@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the Write-Host reference documentation (AB#538621) to better explain why non-primitive inputs can yield unhelpful output and to recommend alternatives with a short example.

Changes:

  • Expanded the NOTES section to include recommended approaches (string interpolation, -f, Out-String) with a sample snippet.
  • Converted several inline links to reference-style links and added link definitions at the bottom.
  • Refreshed ms.date metadata across versions.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
reference/7.6/Microsoft.PowerShell.Utility/Write-Host.md Extends NOTES guidance and refactors links to reference-style definitions.
reference/7.5/Microsoft.PowerShell.Utility/Write-Host.md Same doc updates applied to the 7.5 version.
reference/7.4/Microsoft.PowerShell.Utility/Write-Host.md Same doc updates applied to the 7.4 version.
reference/5.1/Microsoft.PowerShell.Utility/Write-Host.md Same doc updates applied to the Windows PowerShell 5.1 version.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@michaeltlombardi michaeltlombardi force-pushed the ab-538621/main/write-host-formatting branch 2 times, most recently from d7f2d7a to a59bcdb Compare April 1, 2026 16:44
@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@learn-build-service-prod

This comment was marked as outdated.

@michaeltlombardi michaeltlombardi requested a review from Copilot April 1, 2026 17:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@michaeltlombardi michaeltlombardi force-pushed the ab-538621/main/write-host-formatting branch from a59bcdb to b7efbc4 Compare April 1, 2026 17:31
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit b7efbc4:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Utility/Write-Host.md ✅Succeeded View (powershell-5.1)
reference/7.4/Microsoft.PowerShell.Utility/Write-Host.md ✅Succeeded View (powershell-7.4)
reference/7.5/Microsoft.PowerShell.Utility/Write-Host.md ✅Succeeded View (powershell-7.5)
reference/7.6/Microsoft.PowerShell.Utility/Write-Host.md ✅Succeeded View (powershell-7.6)

For more details, please refer to the build report.

Copy link
Copy Markdown
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.

LGTM

@sdwheeler sdwheeler merged commit ae01078 into MicrosoftDocs:main Apr 1, 2026
5 checks passed
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.

3 participants