Docs: Add type annotations & docstrings #298
Draft
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 purely adds some type annotations and docstrings, helpful when understanding the library (new contributors), and for reference without having to navigate to the source (docs directly from the hover in the IDE). No changes in logic. There seems to be a test failing in master (at least in my setup), haven't gone through it yet. Also there seems to be an issue with
lmove. This was introduced in Redis 6.2.0, so I wonder if tests against 3.5 should actually work (redis-py=<3.5.3is for Redis <=6.2, anything after that should requireredis-py>=4.1.0). Will try to spend some time looking into it this week.