resilient-python-api
resilient-python-api copied to clipboard
Revise the HTTP methods’ docstrings to include accurate type annotations
Update HTTP methods' docstrings with correct types according to the base class co3base.py.
Description
The docstrings for the post and put methods have been updated to reflect the correct types (according to the base class) for the payload parameter.
Motivation and Context
Prevent potential misunderstandings and errors in using these methods.
Fixes #
How Has This Been Tested?
The changes are limited to docstrings and therefore do not require new tests.
Checklist:
- [x] I have added a Signed-off-by
- [x] Either no new documentation is required by this change, OR I added new documentation
- [x] Either no new tests are required by this change, OR I added new tests
- [x] I have run pep8 and pylint. I have cleaned up all valid errors and warnings in code I have added or modified. These tools may generate false positives. Don't be worried about ignoring some errors or warnings. The goal is clean, consistent, and readable code.
Signed-off-by:
Barry [email protected]