Skip to content

Conversation

GregHolmes
Copy link
Contributor

Description

This PR converts the Realtime SDK Statistics API reference page from Textile format to MDX, as part of a full textile to MDX migration.

@GregHolmes GregHolmes self-assigned this Oct 9, 2025
@GregHolmes GregHolmes added the review-app Create a Heroku review app label Oct 9, 2025
@ably-ci ably-ci temporarily deployed to ably-docs-edu-2046-conv-rgoief October 9, 2025 12:03 Inactive
Copy link

coderabbitai bot commented Oct 9, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch EDU-2046-Convert-Pub-Sub-JavaScript-API-refs-to-MDX

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
Contributor

@m-hulbert m-hulbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are going to be painful to review, but thanks for getting the ball rolling!


<If lang="javascript,nodejs,java,csharp">

| Parameter | Type | Description |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these should all have the order changed to:

Paramater | Description | Type | Default |

We may even want to role the default into the description if it saves room / is simple.


`PaginatedResult<Stats> stats(Param[] options)`

See [PaginatedResult](/docs/api/realtime-sdk/types#paginated-result), [Stats](#stats-type) and [Param](#param) for type details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to still include these? I don't think so if the actual links are in the description of the method. We can just lose the links in the signature.


`ARTStatsGranularity` is an enum specifying the granularity of a [ARTStats interval](/docs/api/rest-sdk/statistics#stats-type).

<Code>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you include both in the same code tag then we start getting a switcher in the codeblock, which isn't what we should be going for in the refs I don't think.


<If lang="ruby">

`stats(options: Hash) → yields PaginatedResult<Stats>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a different signature to live?


#### Returns

A [Deferrable](/docs/api/realtime-sdk/types#deferrable) object is returned from the stats method.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is different on live.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

3 participants