-
Notifications
You must be signed in to change notification settings - Fork 85
DX-2186: document redis stream commands #551
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
Conversation
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.
Checked the TS part importing Redis and checking the commands one by one, if there are changes in the TS part the correspondent of the py files should also be fixed
| </ParamField> | ||
|
|
||
| <ParamField body="count" type="number"> | ||
| The maximum number of entries to return. |
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.
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.
appears as number to me
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.
Pull Request Overview
Adds comprehensive documentation for Redis Streams commands across TypeScript and Python SDKs and updates navigation.
- Introduces TS and Py pages for core stream commands (XADD, XRANGE, XREAD, XREADGROUP, XREVRANGE, XACK, XCLAIM, XAUTOCLAIM, XPENDING, XLEN, XGROUP variants, XINFO variants, XTRIM).
- Updates overview pages and docs.json to surface the new Stream command sections.
Reviewed Changes
Copilot reviewed 36 out of 36 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| redis/sdks/ts/commands/stream/xtrim.mdx | Adds TS docs for XTRIM with options and examples. |
| redis/sdks/ts/commands/stream/xrevrange.mdx | Adds TS docs for XREVRANGE with typed response and examples. |
| redis/sdks/ts/commands/stream/xreadgroup.mdx | Adds TS docs for XREADGROUP, its options, and response shape. |
| redis/sdks/ts/commands/stream/xread.mdx | Adds TS docs for XREAD with options and examples. |
| redis/sdks/ts/commands/stream/xrange.mdx | Improves TS XRANGE examples and adds a response example. |
| redis/sdks/ts/commands/stream/xpending.mdx | Adds TS docs for XPENDING with options and examples. |
| redis/sdks/ts/commands/stream/xlen.mdx | Adds TS docs for XLEN. |
| redis/sdks/ts/commands/stream/xinfo.mdx | Adds TS docs for XINFO GROUPS/CONSUMERS. |
| redis/sdks/ts/commands/stream/xgroup.mdx | Adds TS docs for XGROUP subcommands in a unified API. |
| redis/sdks/ts/commands/stream/xdel.mdx | Adds TS docs for XDEL. |
| redis/sdks/ts/commands/stream/xclaim.mdx | Adds TS docs for XCLAIM with options and examples. |
| redis/sdks/ts/commands/stream/xautoclaim.mdx | Adds TS docs for XAUTOCLAIM with options and examples. |
| redis/sdks/ts/commands/stream/xadd.mdx | Enhances TS XADD options and examples. |
| redis/sdks/ts/commands/stream/xack.mdx | Adds TS docs for XACK. |
| redis/sdks/ts/commands/overview.mdx | Adds Stream commands section/cards to TS overview. |
| redis/sdks/py/commands/stream/xtrim.mdx | Adds Py docs for XTRIM with options and examples. |
| redis/sdks/py/commands/stream/xrevrange.mdx | Adds Py docs for XREVRANGE. |
| redis/sdks/py/commands/stream/xreadgroup.mdx | Adds Py docs for XREADGROUP. |
| redis/sdks/py/commands/stream/xread.mdx | Adds Py docs for XREAD. |
| redis/sdks/py/commands/stream/xrange.mdx | Fixes Py XRANGE param docs and expands examples. |
| redis/sdks/py/commands/stream/xpending.mdx | Adds Py docs for XPENDING (summary and range forms). |
| redis/sdks/py/commands/stream/xlen.mdx | Adds Py docs for XLEN. |
| redis/sdks/py/commands/stream/xinfo_groups.mdx | Adds Py docs for XINFO GROUPS. |
| redis/sdks/py/commands/stream/xinfo_consumers.mdx | Adds Py docs for XINFO CONSUMERS. |
| redis/sdks/py/commands/stream/xgroup_setid.mdx | Adds Py docs for XGROUP SETID. |
| redis/sdks/py/commands/stream/xgroup_destroy.mdx | Adds Py docs for XGROUP DESTROY. |
| redis/sdks/py/commands/stream/xgroup_delconsumer.mdx | Adds Py docs for XGROUP DELCONSUMER. |
| redis/sdks/py/commands/stream/xgroup_createconsumer.mdx | Adds Py docs for XGROUP CREATECONSUMER. |
| redis/sdks/py/commands/stream/xgroup_create.mdx | Adds Py docs for XGROUP CREATE. |
| redis/sdks/py/commands/stream/xdel.mdx | Adds Py docs for XDEL. |
| redis/sdks/py/commands/stream/xclaim.mdx | Adds Py docs for XCLAIM. |
| redis/sdks/py/commands/stream/xautoclaim.mdx | Adds Py docs for XAUTOCLAIM. |
| redis/sdks/py/commands/stream/xadd.mdx | Reworks Py XADD params and examples. |
| redis/sdks/py/commands/stream/xack.mdx | Adds Py docs for XACK. |
| redis/sdks/py/commands/overview.mdx | Adds Stream commands section/cards to Py overview. |
| docs.json | Adds Stream groups/pages for TS and Py to navigation. |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

No description provided.