Skip to content

fix(doc): adjust document wording#2263

Merged
goldmedal merged 1 commit into
mainfrom
fix/fix-document-wording
May 13, 2026
Merged

fix(doc): adjust document wording#2263
goldmedal merged 1 commit into
mainfrom
fix/fix-document-wording

Conversation

@PaulChen79
Copy link
Copy Markdown
Contributor

@PaulChen79 PaulChen79 commented May 13, 2026

Summary by CodeRabbit

  • Documentation
    • Updated wren memory fetch and wren memory recall command examples with clearer English queries and explicit parameter specifications for improved clarity.

Review Change Stack

@PaulChen79 PaulChen79 self-assigned this May 13, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 13, 2026

Caution

Review failed

Pull request was closed or merged during review

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: 967da7ea-1347-4279-a151-d82f8a3e0f1f

📥 Commits

Reviewing files that changed from the base of the PR and between ff6ae50 and d2a6dc0.

📒 Files selected for processing (2)
  • docs/core/guides/memory.md
  • docs/core/reference/cli.md

Walkthrough

This PR updates CLI command examples for wren memory fetch and wren memory recall across two documentation files. Non-English query strings are replaced with English equivalents ("order date" and "monthly revenue"), and the memory recall example now includes explicit --datasource, --limit, and --output flags.

Changes

CLI Memory Command Examples

Layer / File(s) Summary
Memory fetch and recall command examples
docs/core/guides/memory.md, docs/core/reference/cli.md
Updated wren memory fetch example from a non-English query to "order date" with matching flags, and updated wren memory recall example from a non-English query to "monthly revenue" with explicit datasource, limit, and output format flags across both documentation locations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • wwwy3y3

Poem

🐰 A query in English now shines so bright,
From "日期" to "order date"—what a sight!
The examples are clearer, more global in reach,
With flags that are explicit, and documentation to teach.
The bunny approves of this localization quest! 🌍✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'fix(doc): adjust document wording' is vague and does not clearly convey the specific changes made. It uses a generic phrase 'adjust document wording' that fails to highlight the main change: replacing non-English query examples with English equivalents in the memory command documentation. Use a more descriptive title such as 'fix(doc): replace non-English query examples with English in memory command docs' to clearly communicate the specific documentation updates.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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/fix-document-wording

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.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 13, 2026
@goldmedal goldmedal merged commit fa70ed8 into main May 13, 2026
3 of 4 checks passed
@goldmedal goldmedal deleted the fix/fix-document-wording branch May 13, 2026 08:48
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants