-
Notifications
You must be signed in to change notification settings - Fork 548
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
Improve documentation, add references to redis-macros #769
Conversation
I think linking to your crate should be restricted to the README and maybe one other high-level section in the documentation. Maybe we can then still have some of these other parts of the documentation link to that section? |
I removed the references from the lower-level documentation. I left the fixes of the documentation I did for the RedisJSON section, it seemed to contain some outdated code snippets. I also added that the responses will be wrapped in a |
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.
Looks great, thanks! @jaymell any thoughts?
Sorry for not getting to this faster, but I fixed the test and lint errors. Is there anything else for me to do to move this PR along? |
@daniel7grant I'd actually prefer it if we leave the doc changes out of |
I'm somewhat concerned because this change eliminates the bulk of the documentation I added, except a line in the README. Nevertheless if you prefer it this way, then it's fine by me. |
Thanks, I appreciate it. Your points are noted, I just wanted to keep a reference out of the main docs at this point, as I personally haven't vetted/looked at the crate. |
I understand, my crate is far from being stable, I just hope it will help some people. Please tell me, if you can get to look over the crate and have any feedback. Thanks for the help! |
Just wanted to chime in here and say that a pointer to |
This is made in reference of #740.
The crate redis-macros adds derive macros for
FromRedisValue
andToRedisArgs
, as well as a wrapper typeJson
to unwrap RedisJSON command results. I added suggestions for users to use these macros at several places in the documentation where types were mentioned. I fixed the documentation code blocks inJsonCommands
, and added more information about RedisJSON results, and how to unwrap it withJson
.Feel free to edit if you find any inaccuracies.