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

Add documentation or typing annotatations #143

Open
ShadowJonathan opened this issue Sep 20, 2020 · 1 comment
Open

Add documentation or typing annotatations #143

ShadowJonathan opened this issue Sep 20, 2020 · 1 comment

Comments

@ShadowJonathan
Copy link
Contributor

Currently, when surveying this library for its intended usage in another application, i found out it does not annotate any types of its sort, tracing all the way back to a cryptic execute_command function reference, with which i could not (reliably) found out what kind of type translation takes place back to python typing.

I could also not find any supplementary documentation stating all/any of this, which does not help at all.

Please add some rudimentary documentation detailing return types and some basic overview of the library, or type annotations tho implicitly signal to IDEs or static analysis tools what type is returned when executing certain functions.

@IlyaSkriblovsky
Copy link
Owner

Yeah, docs for this library leaves much space for improvement :(

I'm currently integrating mypy checking into my work project where we use this txredisapi library, so I will eventually face the same issue of type annotations absence.

I will try to find time to write down some details and add type hints for txredisapi.

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

No branches or pull requests

2 participants