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

No documentation for v5.0.2 to v5.0.8, especially new hash field expiration commands #3360

Open
aneroid opened this issue Aug 22, 2024 · 0 comments

Comments

@aneroid
Copy link

aneroid commented Aug 22, 2024

Version: redis-py 5.0.7 & 5.0.8.

Platform: Python 3.12.5 on Windows 10

Description: Documentation for v5.0.2 to v5.0.8 is missing.

The docs for redis-py don't list the versions from v5.0.2 to v5.0.8. Even putting the version in the URL does not work. For example, v5.0.1 can be accessed at https://redis-py.readthedocs.io/en/v5.0.1/commands.html. But this doesn't work for:

URLs for versions which don't have docs:

As an example, the support for hash field expiration commands hexpire, hpexpire, httl, etc. were added in redis-py in this commit and is available in v5.0.8 (but not v5.0.7). But the redis-py docs don't list these commands.

All of these commands work but are not documented. I came across this usage in the main redis docs and examples:

>>> event = {
...     'air_quality': 256,
...     'battery_level':89
... }
>>> r.hset('sensor:sensor1', mapping=event)
2
>>> r.hexpire('sensor:sensor1', 60, 'air_quality', 'battery_level')
[1, 1]
>>> r.httl('sensor:sensor1', 'air_quality', 'battery_level')
[54, 54]

I'm not sure if it's intentional that specific-version docs for v5.0.2 to v5.0.7 would not not generated. But, imho, when a new command is added or functional changes occur, it should definitely trigger the generation of updated docs.

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

1 participant