Refactor/improve documentation #8
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
codebien
requested changes
Aug 2, 2022
mstoykov
approved these changes
Aug 2, 2022
As raised by #6, the use of xk6-redis' module APIs was not clear, nor thorough enough; especially in a context where it would need to be used side by side with synchronous APIs.
This commit adds a usage section to the README in order to outline the asynchronous and promise-based API of the redis module. It includes instructions, warnings, and caveats to inform and help the user to use the module effectively.
oleiade
force-pushed
the
refactor/improve_documentation
branch
from
46f1f4b
to
e7e95dc
Compare
codebien
approved these changes
Aug 2, 2022
mstoykov
approved these changes
Aug 2, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds small improvements to the project, in preparation of the merge to core, and the documentation website update that will be surely necessary.
It would be super valuable if you could let me know any questions you might have/had that might not be tackled by the README, so I can make sure to add them.
Cheers 馃檱馃徎