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.

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

docs: add docstrings detailing the filter options #1435

Merged
merged 2 commits into from
Aug 22, 2024

Conversation

jorwoods
Copy link
Contributor

@jorwoods jorwoods commented Aug 6, 2024

Add docstrings to QuerySetEndpoint subclasses so that details on what filter options are available can be displayed within the editor rather than navigating to the docs separately.

Copy link
Contributor

@bcantoni bcantoni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. @jacalata could you also please review this one?

Copy link
Contributor

@jacalata jacalata left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. We should figure out a way to just publish the list of filters with each version.

@jacalata jacalata merged commit a3028d7 into tableau:development Aug 22, 2024
22 checks passed
@jorwoods jorwoods deleted the jorwoods/filter_docstrings branch August 22, 2024 20:19
@jorwoods
Copy link
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants