Wrong type annotation in workbook.refresh #1318
Comments
pes-magic
added a commit
to pes-magic/server-client-python
that referenced
this issue
Nov 13, 2023
`workbook.refresh` is implemented to accept both `WorkbookItem` and `str` as arguments, but the type annotation describes it as receiving `str`, which can cause false warnings in static analysis. Since the documentation states that it receives `workbook_item`, the name of the argument is also changed from `workbook_id` to `workbook_item`. Issue: tableau#1318
|
@pes-magic Can you mark this as closed by #1319? |
|
Sure, thank you for reminding me |
gconklin
pushed a commit
to gconklin/tableauserverclient
that referenced
this issue
May 28, 2024
`workbook.refresh` is implemented to accept both `WorkbookItem` and `str` as arguments, but the type annotation describes it as receiving `str`, which can cause false warnings in static analysis. Since the documentation states that it receives `workbook_item`, the name of the argument is also changed from `workbook_id` to `workbook_item`. Issue: tableau#1318
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
workbooks.refreshis implemented to receiveworkbook_idas a string type argument, but it can actually receiveWorkbookItemas well. The documentation also states that it receivesworkbook_item.Implementation: https://github.com/tableau/server-client-python/blob/master/tableauserverclient/server/endpoint/workbooks_endpoint.py#L91
Documentation: https://tableau.github.io/server-client-python/docs/api-ref#workbooksrefresh
Versions
To Reproduce
Nothing to do
Results
Static code analysis displays false warnings
The text was updated successfully, but these errors were encountered: