Repository navigation
Fix documentation errors in help, README, RELEASING, and CHANGELOG - #12
Merged
Merged
Conversation
- Get-ScriptMessageConfig, Set-ScriptMessageConfigFilePath: the help's .PARAMETER entry named ConfigPath and Service instead of Path, so Get-Help showed no description for -Path. - Send-ScriptMessage help example 4: close the attachment array with ) instead of }, and end the example by calling Send-ScriptMessage. - README.md: remove the link to a Sample_Usage_Scripts folder that does not exist. - RELEASING.md: use a <release> placeholder in the [Unreleased] compare link instead of a hard-coded 1.2.0. - CHANGELOG.md: point the 1.0.0 heading at this repository instead of SKYAPI, and add [Unreleased] with the help fixes.
There was a problem hiding this comment.
🟢 Approval recommended
Changes are limited to documentation/comment-based help corrections and align with the stated intent without introducing behavioral code changes.
Pull request overview
This PR corrects documentation and comment-based help issues across the ScriptMessage PowerShell module so that Get-Help output and repository docs are accurate and copy/pasteable, without changing runtime behavior.
Changes:
- Fixes comment-based help
.PARAMETERnames forGet-ScriptMessageConfigandSet-ScriptMessageConfigFilePathso-Pathshows a description inGet-Help. - Fixes the
Send-ScriptMessagehelp example for attachments so it parses correctly and actually callsSend-ScriptMessage. - Cleans up docs links/placeholders in
README.md,RELEASING.md, andCHANGELOG.md(including correcting the 1.0.0 tag link target and adding an[Unreleased]section).
File summaries
| File | Description |
|---|---|
| ScriptMessage/Public/Set-ScriptMessageConfigFilePath.ps1 | Corrects help parameter name to .PARAMETER Path to match -Path. |
| ScriptMessage/Public/Send-ScriptMessage.ps1 | Fixes example attachment array closing and adds the missing Send-ScriptMessage invocation in the help example. |
| ScriptMessage/Public/Get-ScriptMessageConfig.ps1 | Corrects help parameter name to .PARAMETER Path to match -Path. |
| RELEASING.md | Replaces hard-coded compare tag with a <release> placeholder explanation in the inline example. |
| README.md | Removes a link to a non-existent examples folder and points users to Get-Help ... -Examples. |
| CHANGELOG.md | Adds [Unreleased] section for these doc fixes and corrects the 1.0.0 heading link to the ScriptMessage repo. |
Review details
- Files reviewed: 6/6 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes documentation errors in the comment-based help,
README.md,RELEASING.md, andCHANGELOG.md. No codechanges.
Get-ScriptMessageConfigandSet-ScriptMessageConfigFilePath: the.PARAMETERentry namedConfigPathandServiceinstead ofPath, soGet-Helpshowed no description for-Path. The parameter hasalways been
-Path; theConfigPathhelp line came from SKYAPI'sGet-SKYAPIConfig.Send-ScriptMessagehelp example 4: closed the attachment array with}instead of), so copying it failedwith "Missing closing ')' in subexpression", and it never called
Send-ScriptMessage. All four examples nowparse without errors.
README.md: removed the link to aSample_Usage_Scriptsfolder that does not exist.RELEASING.md: the[Unreleased]compare link uses a<release>placeholder instead of a hard-coded1.2.0, asAGENTS.mddoes (Copilot review comment on Keep the [Unreleased] changelog section off main #10).CHANGELOG.md: the 1.0.0 heading linked to the SKYAPI repository. This also adds the[Unreleased]sectionwith two
Minor:entries for the help fixes, which were in 1.1.1.Release classification
Checklist
develop, ormainfor a hotfixCHANGELOG.mdhas an entry in the right section under[Unreleased](added if missing), or the change is not user-visible.\Tests\Invoke-Tests.ps1passes