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

Improve documentation, add references to redis-macros #769

Merged
merged 9 commits into from
May 6, 2023
Merged

Improve documentation, add references to redis-macros #769

merged 9 commits into from
May 6, 2023

Conversation

daniel7grant
Copy link
Contributor

This is made in reference of #740.

The crate redis-macros adds derive macros for FromRedisValue and ToRedisArgs, as well as a wrapper type Json 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 in JsonCommands, and added more information about RedisJSON results, and how to unwrap it with Json.

Feel free to edit if you find any inaccuracies.

@djc
Copy link
Contributor

djc commented Feb 3, 2023

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?

@daniel7grant
Copy link
Contributor Author

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 Vec, I think this is a useful information for people working with RedisJSON. I hope this is okay.

Copy link
Contributor

@djc djc left a 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?

@daniel7grant
Copy link
Contributor Author

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?

@jaymell
Copy link
Contributor

jaymell commented Apr 27, 2023

@daniel7grant I'd actually prefer it if we leave the doc changes out of lib.rs. Do you mind removing those, and we can merge the rest of the changes?

@daniel7grant
Copy link
Contributor Author

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.

@jaymell
Copy link
Contributor

jaymell commented May 3, 2023

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.

@daniel7grant
Copy link
Contributor Author

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!

@jaymell jaymell merged commit 6be0704 into redis-rs:main May 6, 2023
9 checks passed
@thomaseizinger
Copy link

@daniel7grant I'd actually prefer it if we leave the doc changes out of lib.rs. Do you mind removing those, and we can merge the rest of the changes?

Just wanted to chime in here and say that a pointer to redis-macros in lib.rs would have saved me a fair bit of time. At the moment, it is not very discoverable but it is very useful once you've found it!

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.

None yet

4 participants