Skip to content

docs: replace backtick continuations with splatting in init example#22

Merged
tablackburn merged 1 commit into
mainfrom
docs/readme-splat-init-template
May 6, 2026
Merged

docs: replace backtick continuations with splatting in init example#22
tablackburn merged 1 commit into
mainfrom
docs/readme-splat-init-template

Conversation

@tablackburn
Copy link
Copy Markdown
Owner

@tablackburn tablackburn commented May 6, 2026

Summary

  • Replaces line-continuation backticks in the non-interactive Initialize-Template.ps1 example (README.md) with a $templateParameters splat.
  • Splatting reads cleaner, doesn't break on trailing whitespace, and renders consistently at any width.

Follow-on tracked separately: tablackburn/ai-agent-instruction-modules#16 (consider shared style guidance to avoid backticks/semicolons in PowerShell snippets).

Test plan

  • Render README.md on GitHub and confirm the updated code block looks right
  • Copy-paste the splat block into a PowerShell session and confirm it parses

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated Quick start guide with improved examples for template initialization, demonstrating parameter hashtable usage patterns.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 6, 2026 18:43
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b1192803-ae7c-40b0-b485-e0e82205e200

📥 Commits

Reviewing files that changed from the base of the PR and between 40606f1 and b0e39c9.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

Documentation in README.md Quick start section updated to demonstrate parameter passing using a hashtable object with @templateParameters syntax instead of inline command-line parameters to Initialize-Template.ps1.

Changes

Documentation Update

Layer / File(s) Summary
Quick Start Example
README.md
Initialize-Template.ps1 invocation refactored to use $templateParameters hashtable with splatting (@templateParameters) instead of individual -ModuleName, -Prefix, -Author, -Description, -ProjectUri parameters.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through code so neat,
With parameters hashtabled, oh what a treat!
No more inline flags to clutter the call,
Just splatted syntax — the cleanest of all! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: replacing backtick continuations with parameter splatting syntax in the Initialize-Template.ps1 documentation example.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-splat-init-template

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

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 README’s non-interactive Initialize-Template.ps1 usage example to avoid PowerShell backtick line continuations by using a hashtable splat, improving readability and copy/paste robustness in rendered Markdown.

Changes:

  • Replaced backtick-based line continuations in the README init example with a $templateParameters hashtable splat.
  • Kept the same parameter set (ModuleName, Prefix, Author, Description, ProjectUri) while improving formatting resilience.

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

@tablackburn tablackburn merged commit f0bdb02 into main May 6, 2026
15 checks passed
@tablackburn tablackburn deleted the docs/readme-splat-init-template branch May 6, 2026 18:48
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