Skip to content

Add missing RestAnnotation#delete typings#2218

Open
SimonWoolf wants to merge 1 commit intomainfrom
annotation-delete-typings
Open

Add missing RestAnnotation#delete typings#2218
SimonWoolf wants to merge 1 commit intomainfrom
annotation-delete-typings

Conversation

@SimonWoolf
Copy link
Copy Markdown
Member

@SimonWoolf SimonWoolf commented May 6, 2026

just noticed these were missing from the d.ts

Summary by CodeRabbit

  • Style
    • Updated formatting and documentation structure in type definitions to improve consistency.

@SimonWoolf SimonWoolf requested a review from ttypic May 6, 2026 17:32
@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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 944fdd8b-1f63-463a-b797-be4db002391b

📥 Commits

Reviewing files that changed from the base of the PR and between 498d26d and cecf59a.

📒 Files selected for processing (1)
  • ably.d.ts

Walkthrough

A TypeScript declaration file update adds duplicate documentation and method overload entries for annotation deletion operations in the RestAnnotations interface, clarifying available delete method signatures without altering API behavior.

Changes

TypeScript Declaration Duplication

Layer / File(s) Summary
Declaration Additions
ably.d.ts
RestAnnotations interface re-adds delete method overloads with JSDoc: delete(message: Message, annotation: OutboundAnnotation) and delete(messageSerial: string, annotation: OutboundAnnotation) for improved declaration clarity.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A gentle edit, clear and bright,
Delete signatures shining light,
Annotations bloom with duplicate care,
Documentation thrives everywhere! ✨

🚥 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 clearly and concisely describes the main change: adding missing TypeScript type definitions for the RestAnnotation#delete method.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch annotation-delete-typings

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

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.

1 participant