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

Fix inaccurate docstring for unwatch() #3424

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

djroze
Copy link

@djroze djroze commented Nov 5, 2024

The 'unwatch()' method of the Redis client, as currently documented, says that it unwatches the value at key "name", but it does not actually take any arguments ("name" or otherwise). According to the latest Redis documentation at the given URL for the UNWATCH command, this command unwatches all previously watched keys for the current transaction. Modified docstring to reflect that this method does not take any arguments and instead (presumably) unwatches all previously watched keys.

Pull Request check-list

Please make sure to review and check all of these items:

  • Do tests and lints pass with this change?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?
  • Was the change added to CHANGES file?

NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.

Description of change

Please provide a description of the change here.

The 'unwatch()' method of the Redis client, as currently documented, says that it unwatches the value at key "name", but it does not actually take any arguments ("name" or otherwise). According to the latest Redis documentation at the given URL for the UNWATCH command, this command unwatches all previously watched keys for the current transaction. Modified docstring to reflect that this method does not take any arguments and instead (presumably) unwatches all previously watched keys.
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.

1 participant