-
Notifications
You must be signed in to change notification settings - Fork 45
Migrate Statistics Realtime SDK API spec to MDX #2876
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Migrate Statistics Realtime SDK API spec to MDX #2876
Conversation
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this 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 | |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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> |
There was a problem hiding this comment.
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>` |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
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.