Skip to content
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

Redis JSON SDK documentation fixes #398

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

as-celegen
Copy link
Contributor

  • Most of the json functions return as array because of the possibility of wildcard usage
  • Some examples were missing function name and just written as "redis.json(..."
  • Some files had parameters leftover from copy-pasting and some had leftover parameter or return value descriptions

@enesakar
Copy link
Contributor

@mdumandag can you review please

@enesakar enesakar requested a review from mdumandag February 18, 2025 19:49
Copy link
Contributor

@mdumandag mdumandag left a comment

Choose a reason for hiding this comment

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

For the Python SDK, we don't support the JSON commands yet. So, I am not sure why we have documentation for it 😄

I see that it was added in this PR, and we just copy pasted the TS SDK docs. So, we should remove all JSON commands from the Python SDK documentation.

@as-celegen
Copy link
Contributor Author

I have also implemented JSON commands and created a PR for it and tried to write the documentation based on it. If you are interested that one can be reviewed first.

Copy link
Contributor

@mdumandag mdumandag left a comment

Choose a reason for hiding this comment

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

I just checked the Python snippets

Copy link
Contributor

@mdumandag mdumandag left a comment

Choose a reason for hiding this comment

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

OK for Python SDK changes

@as-celegen
Copy link
Contributor Author

@enesakar if possible can you assign someone to review Typescript SDK changes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants