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 for Pub/Sub and add split stream example #65

Merged
merged 1 commit into from
Mar 18, 2024

Conversation

richardhenry
Copy link
Contributor

Thanks for implementing the split() method re: issue #57. I added some (hopefully helpful) documentation and improved the pub/sub documentation a little bit.

@richardhenry
Copy link
Contributor Author

Btw I removed the regular_client.flushdb(FlushingMode::Sync).await? and pub_sub_stream.close().await? lines from the doctests because I thought they distracted from the documentation a little bit and the tests seem to pass without them. If you think I should add them back let me know.

@mcatanzariti
Copy link
Member

The problem if you remove regular_client.flushdb(FlushingMode::Sync).await? from the doc test is that when you run all the doc tests in a row, remaining data from a previous test could make the test fail...

Removing the close should be ok though.

@richardhenry
Copy link
Contributor Author

Amended my commit with that change

@mcatanzariti mcatanzariti merged commit c49b381 into dahomey-technologies:main Mar 18, 2024
3 checks passed
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.

2 participants