Fix parameter name in ConfigMapLock.create docstring - #2665
Conversation
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.
|
|
|
Welcome @LALITH0110! |
|
thanks for the PR |
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
3dad1de
into
kubernetes-client:master
What type of PR is this?
/kind documentation
What this PR does / why we need it:
ConfigMapLock.createdocumented:param electionRecord:, but the parameter is namedelection_record: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. Notekubernetes/leaderelectionis a symlink intokubernetes/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
:paramentries against actual function signatures.Special notes for your reviewer:
The documented parameters on
createnow exactly match its signature (name,namespace,election_record). Nothing underkubernetes/client/was touched, so no generated code is affected, and no tests referenceleaderelection.Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: