Revise the HTTP methods’ docstrings to include accurate type annotations #34
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update HTTP methods' docstrings with correct types according to the base class
co3base.py
.Description
The docstrings for the
post
andput
methods have been updated to reflect the correct types (according to the base class) for thepayload
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:
Signed-off-by:
Barry
[email protected]