Skip to content

Conversation

petyaslavova
Copy link
Collaborator

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)?

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

Description of change

Fixes #3714

@petyaslavova petyaslavova requested a review from Copilot October 3, 2025 10:58
@petyaslavova petyaslavova added the breakingchange API or Breaking Change label Oct 3, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Updates ping command documentation and type hints across Redis client classes to improve clarity and type safety. The changes standardize docstrings to clearly explain the ping functionality and fix return type annotations.

  • Enhanced docstrings with detailed explanations of ping command purpose and usage
  • Updated return type hints to be more specific (bool vs generic ResponseT, Awaitable[bool] vs generic Awaitable)
  • Standardized documentation format across synchronous and asynchronous client implementations

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
redis/commands/core.py Updated ping method return type hint and expanded docstring with detailed functionality description
redis/client.py Enhanced ping method docstring with clearer description of functionality
redis/asyncio/client.py Updated ping method return type hint and enhanced docstring to match synchronous version

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@petyaslavova petyaslavova merged commit 028245c into master Oct 3, 2025
40 checks passed
@petyaslavova petyaslavova deleted the ps_fix_ping_command_docs_and_return_type branch October 3, 2025 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breakingchange API or Breaking Change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation of ping() is not clear
3 participants