Skip to content

Remove stale "connection" arg from get_resolved_ip docstring - #4164

Merged
petyaslavova merged 2 commits into
redis:masterfrom
eeshsaxena:fix-docstring-stale-arg
Jul 7, 2026
Merged

petyaslavova merged 2 commits into
redis:masterfrom
eeshsaxena:fix-docstring-stale-arg

Conversation

@eeshsaxena

@eeshsaxena eeshsaxena commented Jul 3, 2026 •

Copy link
Copy Markdown
Contributor

Pull Request check-list

  • Do tests and lints pass with this change? (doc-only, no behavior change)
  • Is the new or changed code fully tested? (n/a - docstring-only)
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?

Description of change

AbstractConnection.get_resolved_ip takes no arguments (it operates on self), but its docstring documents a connection parameter left over from an earlier signature. This removes the stale Args: block.


Note

Low Risk
Documentation-only change with no runtime or API behavior impact.

Overview
Updates the get_resolved_ip docstring on MaintNotificationsAbstractConnection so it matches the real API: the method only uses self (socket peer name, then DNS on host/port).

Removes the leftover Args: block that documented a connection parameter from an older signature.

Reviewed by Cursor Bugbot for commit ee3a8e9. Bugbot is set up for automated code reviews on this repo. Configure here.

AbstractConnection.get_resolved_ip takes no arguments; it operates on
self. The documented `connection` parameter is left over from an
earlier signature.
@jit-ci

jit-ci Bot commented Jul 3, 2026

Copy link
Copy Markdown

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

@eeshsaxena eeshsaxena changed the title Remove stale arg from get_resolved_ip docstring Remove stale "connection" arg from get_resolved_ip docstring Jul 3, 2026

@petyaslavova petyaslavova left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM.

@petyaslavova
petyaslavova merged commit b121809 into redis:master Jul 7, 2026
342 checks passed
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.

2 participants