docs: workbook docstrings #1488
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jorwoods
force-pushed
the
jorwoods/wb_docstrings
branch
2 times, most recently
from
837d030 to
0fcbd0c
Compare
jacalata
reviewed
Oct 14, 2024
| -------- | ||
|
|
||
| >>> import tableauserverclient as TSC | ||
| >>> tableau_auth = TSC.TableauAuth('username', 'password', site_id='site') |
There was a problem hiding this comment.
I'm not sure about having all this sample code in the doc strings, it'll be easy to let it get out of date. I'm hoping to go the other direction and make it possible to run all the sample files regularly - perhaps significant code snippets could be put in a sample, and the comment could point there?
There was a problem hiding this comment.
I can remove the examples.
Add detailed docstrings to workbook item and endpoint
jorwoods
force-pushed
the
jorwoods/wb_docstrings
branch
from
05d5248 to
a1aacb3
Compare
jacalata
approved these changes
Oct 15, 2024
jacalata
pushed a commit
that referenced
this pull request
Oct 24, 2024
* Feature: export custom views #999 (#1506) * feat(exceptions): separate failed signin error (#1478) * refactor request_options, add language param (#1481) * Set FILESIZE_LIMIT_MB via environment variables (#1466) * added PulseMetricDefine cap (#1490) * Adding project permissions handling for databases, tables and virtual connections (#1482) * fix: queryset support for flowruns (#1460) * fix: set unknown size to sys.maxsize * fix: handle 0 item response in querysets (#1501) * chore: support VizqlDataApiAccess capability (#1504) * refactor(test): extract error factory to _utils * chore(typing): flowruns.cancel can also accept a FlowRunItem * chore: type hint default permissions endpoints (#1493) * chore(versions): update remaining f-strings (#1477) * Make urllib3 dependency more flexible (#1468) * Update requests library for CVE CVE-2024-35195 (#1507) * chore(versions): Upgrade minimum python version (#1465) * ci: cache dependencies for faster builds (#1497) * ci: build on python 3.13 (#1492) * Update samples for Python 3.x compatibility (#1479) * chore: remove py2 holdover code (#1496) * #Add 'description' to datasource sample code (#1475) * Remove sample code showing group name encoding (#1486) * chore(typing): include samples in type checks (#1455) * fix: docstring on QuerySet * docs: add docstrings to auth objects and endpoints (#1484) * docs: docstrings for Server and ServerInfo (#1494) * docs: docstrings for user item and endpoint (#1485) * docs: docstrings for site item and endpoint (#1495) * docs: workbook docstrings (#1488) * #1464 - docs update for filtering on boolean values (#1471) --------- Co-authored-by: Brian Cantoni <[email protected]> Co-authored-by: Jordan Woods <[email protected]> Co-authored-by: Jordan Woods <[email protected]> Co-authored-by: Jac <[email protected]> Co-authored-by: Henning Merklinger <[email protected]> Co-authored-by: AlbertWangXu <[email protected]> Co-authored-by: TrimPeachu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add detailed docstrings to workbook item and endpoint