Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise the HTTP methods’ docstrings to include accurate type annotations #34

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

barryyosi-panw
Copy link

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:

  • I have added a Signed-off-by
  • Either no new documentation is required by this change, OR I added new documentation
  • Either no new tests are required by this change, OR I added new tests
  • 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]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant