The current provided example for the initialize() method: a) doesn't work, and b) does not conform to the method signature described immediately afterward. The suggested change yields a functional example and is conformant.
Requirements for Contributing to this repository
Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
The pull request must only fix one issue, or add one feature, at the time.
The pull request must update the test suite to demonstrate the changed functionality.
After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.
What does this PR do?
This PR provides a fix for a broken example.
Description of the Change
The change specifically corrects the expression of the 3rd and 4th function parameters in the example.
Alternate Designs
This was the least disruptive change to achieve a working example.
Possible Drawbacks
No negative side-effects. The example goes from non-working to working.
Verification Process
I use black for checking Python code. As strict as it is, it has no problem with the amended example.
Additional Notes
Not really -- the change is about as simple as anything can be in code.
Release Notes
Review checklist (to be filled by reviewers)
[ ] Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
[ ] PR title must be written as a CHANGELOG entry (see why)
[ ] Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
[ ] PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
[ ] PR should not have do-not-merge/ label attached.
[ ] If Applicable, issue must have kind/ and severity/ labels attached at least.
The current provided example for the initialize() method: a) doesn't work, and b) does not conform to the method signature described immediately afterward. The suggested change yields a functional example and is conformant.
Requirements for Contributing to this repository
What does this PR do?
This PR provides a fix for a broken example.
Description of the Change
The change specifically corrects the expression of the 3rd and 4th function parameters in the example.
Alternate Designs
This was the least disruptive change to achieve a working example.
Possible Drawbacks
No negative side-effects. The example goes from non-working to working.
Verification Process
I use black for checking Python code. As strict as it is, it has no problem with the amended example.
Additional Notes
Not really -- the change is about as simple as anything can be in code.
Release Notes
Review checklist (to be filled by reviewers)
changelog/label attached. If applicable it should have thebackward-incompatiblelabel attached.do-not-merge/label attached.kind/andseverity/labels attached at least.