-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Closed
Labels
issue-doc-bugIssue - error in documentationIssue - error in documentation
Description
Prerequisites
- Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
- Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Typo in
Get-Foocmdlet" instead of "Typo." - Verify Version: If there is a mismatch between documentation and the behavior on your system, ensure that the version you are using is the same as the documentation. Check this box if they match or the issue you are reporting is not version specific.
Links
https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_signing
https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/convertfrom-json
https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/invoke-restmethod
https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_regular_expressions
Summary
As a follow-up to the recently added about_Comments, the individual documents linked above are missing comment-related information.
Suggested Fix
about_Signing- Include a note about the
# SIGsignature block comments which are added after a PowerShell file is signed.
- Include a note about the
ConvertFrom-Json- In the existing Description note on JSON comments, mention block comments (
/* */).
- In the existing Description note on JSON comments, mention block comments (
Invoke-RestMethod- Add a note stating that JSON comments are supported in deserialized JSON data.
about_Regular_Expressions- Add a new heading to describe regex comments.
- This is essentially covered already by the Long description note, so isn't strictly required. However, I believe it's worth including. Regex comments are arguably underutilized in the PowerShell world despite being a valuable .NET regex feature.
Metadata
Metadata
Assignees
Labels
issue-doc-bugIssue - error in documentationIssue - error in documentation