Skip to content

Conversation

sdwheeler
Copy link
Collaborator

@sdwheeler sdwheeler commented Sep 22, 2025

PR Summary

Update docs on comment-based help

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.

@sdwheeler sdwheeler marked this pull request as draft September 22, 2025 21:18
Copy link
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. 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.

Copy link
Contributor

Learn Build status updates of commit 24b5739:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md ✅Succeeded View (powershell-5.1)
reference/7.4/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md ✅Succeeded View (powershell-7.4)
reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md ✅Succeeded View (powershell-7.5)
reference/7.6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md ✅Succeeded View (powershell-7.6)
reference/docs-conceptual/developer/help/comment-based-help-keywords.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/help/naming-help-files.md ✅Succeeded View (>=powershell-5.1)
reference/docs-conceptual/developer/help/writing-help-for-windows-powershell-modules.md ✅Succeeded View (>=powershell-5.1)

For more details, please refer to the build report.

@sdwheeler sdwheeler marked this pull request as ready for review September 23, 2025 20:35
@michaeltlombardi michaeltlombardi merged commit 82f8f14 into MicrosoftDocs:main Sep 23, 2025
7 checks passed
@sdwheeler sdwheeler deleted the sdw-w491537-i12374 branch September 29, 2025 15:34
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.

More detailed help for authoring (rather than just using) comment-based help

2 participants