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.

Sign up for GitHub

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

Jump to bottom

Incorrect docstring return type in remove_profile() method #102

Closed
sserrata opened this issue Sep 6, 2018 · 0 comments
Closed

Incorrect docstring return type in remove_profile() method #102

sserrata opened this issue Sep 6, 2018 · 0 comments
Assignees
@sserrata
Labels
documentation Improvements or corrections to documentation

Comments

@sserrata
Copy link
Member

sserrata commented Sep 6, 2018

  • Palo Alto Networks Cloud Python SDK version: v1.3.0
  • Python version: 2.7, 3.5+
  • Operating System: any

Description

The Credentials() and TinyDBStore() remove_profile() methods doctrings specify a return type of int, which is incorrect. The tinydb remove() method returns a type list of all affected IDs.

Proposed solution

Update remove_profile() docstring to specify a return type of list and edit description accordingly.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sserrata sserrata

Labels
documentation Improvements or corrections to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sserrata