docs: docstrings for user item and endpoint #1485
Open
+377
−0
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
jacalata
approved these changes
Oct 4, 2024
|
Its a mix of copying information in from https://tableau.github.io/server-client-python/docs/api-ref, https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm, and adding some extra detail where appropriate. The main thing I'm unsure of is detailing all of the ServerResponseError codes and details or if it should just point them to the server REST API docs for that detail. |
|
The reason for pulling this info into docstrings from the docs is if we go forward with the rewrite per #1451, then we could pull the docstrings in as the documentation. Making it available both in the web and in the IDE. |
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.
No description provided.