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.

Sign up for GitHub

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

Jump to bottom

Add IsParseError() documentation #578

Closed
rueian opened this issue Jun 22, 2024 · 2 comments
Closed

Add IsParseError() documentation #578

rueian opened this issue Jun 22, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@rueian
Copy link
Collaborator

rueian commented Jun 22, 2024

Since #555 and #564, the following statement Otherwise, it panics. is no longer correct and should be removed.

rueidis/README.md

Lines 437 to 438 in 5fe0175

While the command builder is developer-friendly, the response parser is a little unfriendly. Developers must know what
type of Redis response will be returned from the server beforehand and which parser they should use. Otherwise, it panics.

Besides the removal, we should make it clear that an errParse will be returned if choosing a wrong parser function and the IsParseErr helper can be used for checking the case.
@rueian rueian added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 22, 2024
@karimalzalek
Copy link
Contributor

Hello @rueian , since this is a simple documentation change, will take a chance to contribute my first change.
I read the documentation under

In the PR I will remove Otherwise, it panics. and add the info about errParse and IsParseErr

karimalzalek added a commit to karimalzalek/rueidis that referenced this issue Jun 24, 2024
@karimalzalek
Changes for (Add IsParseError() documentation redis#578)
605b6d8
karimalzalek added a commit to karimalzalek/rueidis that referenced this issue Jun 24, 2024
@karimalzalek
Changes for (Add IsParseError() documentation redis#578)
45b18e3
karimalzalek added a commit to karimalzalek/rueidis that referenced this issue Jun 24, 2024
@karimalzalek
Changes for (Add IsParseError() documentation redis#578)
4c84add
rueian pushed a commit that referenced this issue Jun 28, 2024
@karimalzalek @SoulPancake
Changes for (Add IsParseError() documentation #578) (#581)
b19f550 
* Changes for (Add IsParseError() documentation #578)

* Changes for (Add IsParseError() documentation #578)

* Changes for (Add IsParseError() documentation #578)

* Delete .vscode/settings.json

Removing wrong settings.json file

* Update README.md

Co-authored-by: Anurag Bandyopadhyay <[email protected]>

---------

Co-authored-by: Anurag Bandyopadhyay <[email protected]>
@rueian
Copy link
Collaborator Author

rueian commented Jun 28, 2024

Resolved.

@rueian rueian closed this as completed Jun 28, 2024
@SoulPancake SoulPancake mentioned this issue Jun 29, 2024
Merged
SoulPancake added a commit to SoulPancake/rueidis that referenced this issue Jun 29, 2024
@SoulPancake
Merge pull request #3 from redis/main
66e53fa 
Changes for (Add IsParseError() documentation redis#578) (redis#581)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rueian @karimalzalek