Skip to content

Fix parameter name in ConfigMapLock.create docstring - #2665

Merged
kubernetes-prow[bot] merged 1 commit into
kubernetes-client:masterfrom
LALITH0110:docs/configmaplock-election-record-param
Aug 1, 2026
Merged

Fix parameter name in ConfigMapLock.create docstring#2665
kubernetes-prow[bot] merged 1 commit into
kubernetes-client:masterfrom
LALITH0110:docs/configmaplock-election-record-param

Conversation

@LALITH0110

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

ConfigMapLock.create documented :param electionRecord:, but the parameter is named election_record:

def create(self, name, namespace, election_record):
    """
    :param electionRecord: Annotation string

So the docstring described a parameter that does not exist on the method, while the real one was left undocumented. This corrects the name to match the signature.

The change is in kubernetes/base/leaderelection/resourcelock/configmaplock.py. Note kubernetes/leaderelection is a symlink into kubernetes/base/, so there is a single real file and no second copy to update.

One line. Documentation only — no behaviour change.

Which issue(s) this PR fixes:

None — found by comparing documented :param entries against actual function signatures.

Special notes for your reviewer:

The documented parameters on create now exactly match its signature (name, namespace, election_record). Nothing under kubernetes/client/ was touched, so no generated code is affected, and no tests reference leaderelection.

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


The docstring documented `:param electionRecord:`, but the parameter is
named `election_record`. The documented name did not exist on the method,
and the real one was left undocumented.
@kubernetes-prow kubernetes-prow Bot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Jul 31, 2026
@linux-foundation-easycla

linux-foundation-easycla Bot commented Jul 31, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

  • ✅ login: LALITH0110 / name: LALITH0110 (99a1e3c)

@kubernetes-prow
kubernetes-prow Bot requested review from fabianvf and yliaog July 31, 2026 15:53
@kubernetes-prow kubernetes-prow Bot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jul 31, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

Welcome @LALITH0110!

It looks like this is your first PR to kubernetes-client/python 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/python has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@kubernetes-prow kubernetes-prow Bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 31, 2026
@yliaog

yliaog commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

thanks for the PR
/lgtm
/approve

@kubernetes-prow kubernetes-prow Bot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 1, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: LALITH0110, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow kubernetes-prow Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 1, 2026
@kubernetes-prow
kubernetes-prow Bot merged commit 3dad1de into kubernetes-client:master Aug 1, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants