Skip to content

Fix documentation errors in help, README, RELEASING, and CHANGELOG - #12

Merged
Sekers merged 1 commit into
developfrom
feature/docs-quick-fixes
Sep 16, 2026
Merged

Sekers merged 1 commit into
developfrom
feature/docs-quick-fixes

Conversation

@Sekers

@Sekers Sekers commented Sep 16, 2026

Copy link
Copy Markdown
Owner

Summary

Fixes documentation errors in the comment-based help, README.md, RELEASING.md, and CHANGELOG.md. No code
changes.

  • Help for Get-ScriptMessageConfig and Set-ScriptMessageConfigFilePath: the .PARAMETER entry named
    ConfigPath and Service instead of Path, so Get-Help showed no description for -Path. The parameter has
    always been -Path; the ConfigPath help line came from SKYAPI's Get-SKYAPIConfig.
  • Send-ScriptMessage help example 4: closed the attachment array with } instead of ), so copying it failed
    with "Missing closing ')' in subexpression", and it never called Send-ScriptMessage. All four examples now
    parse without errors.
  • README.md: removed the link to a Sample_Usage_Scripts folder that does not exist.
  • RELEASING.md: the [Unreleased] compare link uses a <release> placeholder instead of a hard-coded
    1.2.0, as AGENTS.md does (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] section
    with two Minor: entries for the help fixes, which were in 1.1.1.

Release classification

  • Major: breaks the public contract (an existing script or configuration file can stop working)
  • Minor: adds backward-compatible functionality
  • Patch: a backward-compatible fix
  • None: no user-visible change (tests, CI, or contributor documentation only)

Checklist

  • Targets develop, or main for a hotfix
  • CHANGELOG.md has an entry in the right section under [Unreleased] (added if missing), or the change is not user-visible
  • .\Tests\Invoke-Tests.ps1 passes
  • Contains no real tenant names, email domains, secrets, or configuration files
  • Any live Microsoft Graph testing was done in a test tenant and is described above

- 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.
Copilot AI lite review requested due to automatic review settings September 16, 2026 21:04

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 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 .PARAMETER names for Get-ScriptMessageConfig and Set-ScriptMessageConfigFilePath so -Path shows a description in Get-Help.
  • Fixes the Send-ScriptMessage help example for attachments so it parses correctly and actually calls Send-ScriptMessage.
  • Cleans up docs links/placeholders in README.md, RELEASING.md, and CHANGELOG.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.

@Sekers
Sekers merged commit 44b2b77 into develop Sep 16, 2026
5 checks passed
@Sekers
Sekers deleted the feature/docs-quick-fixes branch September 16, 2026 21:11
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.

2 participants