Skip to content

Conversation

@splindsay-92
Copy link
Contributor

@splindsay-92 splindsay-92 commented Feb 9, 2026

The spaces command examples were showing the usage of a --position flag which doesn't actually exist. Updated to show correct usage or --x and --y flags.


Note

Low Risk
Documentation/example-only updates; no functional or security-sensitive code paths change.

Overview
Fixes documentation/help text for ably spaces cursors by updating set command examples to use --x and --y flags (and --data) instead of the previously documented --position flag.

Changes are limited to README.md and the oclif command example strings in src/commands/spaces/cursors.ts and src/commands/spaces/cursors/index.ts; no runtime behavior is modified.

Written by Cursor Bugbot for commit 20bc06b. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

  • Documentation
    • Updated Spaces Cursors set command examples throughout the documentation, replacing the combined position payload format with separate --x and --y coordinate flags to provide clearer guidance.

@vercel
Copy link

vercel bot commented Feb 9, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cli-web-cli Ready Ready Preview, Comment Feb 9, 2026 0:43am

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Feb 9, 2026

Walkthrough

Updated documentation and example usage across three files to reflect a change in the Ably Spaces cursors set command interface—replacing a single --position payload with separate --x and --y flags for specifying cursor coordinates.

Changes

Cohort / File(s) Summary
Documentation & Examples Update
README.md, src/commands/spaces/cursors.ts, src/commands/spaces/cursors/index.ts
Updated cursor position example usage from --position payload to separate --x and --y coordinate flags across all documentation and static example strings.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Coordinates now dance with clarity,
No bundled position, just x and y,
Each flag stands tall, precise and merry,
Documentation blooms where examples fly! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 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 cursor set command examples to reflect correct flag usage (--x and --y instead of --position).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/correct-spaces-set-examples

No actionable comments were generated in the recent review. 🎉


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.

@splindsay-92 splindsay-92 requested a review from AndyTWF February 9, 2026 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants