Skip to content

docs(skills): quote pip install wrenai[…] consistently#2318

Merged
goldmedal merged 1 commit into
mainfrom
fix/quote-wrenai-pip-install
May 22, 2026
Merged

docs(skills): quote pip install wrenai[…] consistently#2318
goldmedal merged 1 commit into
mainfrom
fix/quote-wrenai-pip-install

Conversation

@PaulChen79
Copy link
Copy Markdown
Contributor

@PaulChen79 PaulChen79 commented May 22, 2026

Summary

Two leftover skill files used unquoted pip install wrenai[<extra>] inside backticks. On zsh (the default macOS shell) the unquoted […] is parsed as a glob pattern and the command fails with zsh: no matches found. Every other skill wraps the spec in double quotes; this PR brings the stragglers in line.

File Change
skills/README.md pip install wrenai / pip install wrenai[<datasource>] → quoted
skills/wren-generate-mdl/SKILL.md pip install wrenai[<datasource>] → quoted

This is the follow-up to #2317 — same theme, two stragglers that didn't get touched there.

Test plan

  • grep -rnE 'pip install [^"]?wrenai\[' skills/ returns no hits.
  • On a fresh zsh shell, pip install "wrenai[memory]" runs without zsh: no matches found.

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated pip installation instructions to ensure proper command formatting.

Review Change Stack

zsh (default shell on macOS) treats unquoted square brackets as a glob
pattern and errors out with `zsh: no matches found` on `pip install
wrenai[memory]`. Every other place in the skill bundle already wraps
the spec in double quotes; bring these two stragglers in line so the
commands work on bash and zsh alike.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation skills labels May 22, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 2b32c310-8f5d-48e5-95e2-397d649c9177

📥 Commits

Reviewing files that changed from the base of the PR and between 7c18619 and f17226a.

📒 Files selected for processing (2)
  • skills/README.md
  • skills/wren-generate-mdl/SKILL.md

Walkthrough

This PR quotes pip package names in installation instructions across skills documentation to improve shell compatibility and consistency. The wrenai package and its extras syntax (wrenai[<datasource>]) are now quoted in both the main requirements section and skill-specific prerequisites.

Changes

Skills Documentation Updates

Layer / File(s) Summary
Quote pip package specifications in install instructions
skills/README.md, skills/wren-generate-mdl/SKILL.md
The pip install commands are updated to quote the wrenai package name and wrenai[<datasource>] extras syntax for shell safety.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • Canner/WrenAI#2315: The main PR's doc-only tweaks in skills/README.md and skills/wren-generate-mdl/SKILL.md (quoting the pip install "wrenai[<datasource>]" command) build directly on the retrieved PR's broader wren-enginewrenai rename in the same install-instruction locations.
  • Canner/WrenAI#2316: Both PRs update Wren AI documentation around the wren-enginewrenai rename/migration, including pip install ...wrenai[...] install-command text in README guidance.
  • Canner/WrenAI#2317: Both PRs update documentation/skill metadata around the wrenai PyPI package in pip install instructions (main PR adds quoted extras syntax in skills docs, while retrieved PR renames prior wren-engine references to wrenai).

Suggested labels

documentation, skills

Suggested reviewers

  • douenergy
  • goldmedal

Poem

🐰 With shell-safe quotes, the pip commands now shine,
Package names wrapped in apostrophes fine,
Through skills and through docs, consistency spreads,
A hop and a bound through the install threads!

🚥 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 describes the main change: updating documentation to quote pip install commands for wrenai packages consistently across skill files.
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 fix/quote-wrenai-pip-install

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.

@goldmedal goldmedal merged commit a523d7b into main May 22, 2026
5 checks passed
@goldmedal goldmedal deleted the fix/quote-wrenai-pip-install branch May 22, 2026 06:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation skills

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants