docs: add docstrings detailing the filter options#1435
Merged
jacalata merged 2 commits intotableau:developmenttableau/server-client-python:developmentfrom Aug 22, 2024
jorwoods:jorwoods/filter_docstringsjorwoods/server-client-python:jorwoods/filter_docstringsCopy head branch name to clipboard
Merged
docs: add docstrings detailing the filter options#1435jacalata merged 2 commits intotableau:developmenttableau/server-client-python:developmentfrom jorwoods:jorwoods/filter_docstringsjorwoods/server-client-python:jorwoods/filter_docstringsCopy head branch name to clipboard
jacalata merged 2 commits intotableau:developmenttableau/server-client-python:developmentfrom
jorwoods:jorwoods/filter_docstringsjorwoods/server-client-python:jorwoods/filter_docstringsCopy head branch name to clipboard
Conversation
jacalata
approved these changes
Aug 22, 2024
Contributor
jacalata
left a comment
There was a problem hiding this comment.
Looks good. We should figure out a way to just publish the list of filters with each version.
Contributor
Author
|
Yeah, the way I compiled this list was by scraping the filtering and sorting docs. May be difficult to update it with every server version. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 docstrings to
QuerySetEndpointsubclasses so that details on what filter options are available can be displayed within the editor rather than navigating to the docs separately.