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

Improve the display of route-based warning messages, particularly in the user guide #28

Open
toph-allen opened this issue Sep 29, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@toph-allen
Copy link
Collaborator

Right now, when type annotations are insufficient for us to generate Tableau usage examples, we display a warning message in its place.

We could instead pass this data up to the RouteInfo object and use this to alter the display of the function in the user guide, to provide a more distinct and informative warning message.

This would also be a good place to surface warnings about endpoints that do not meet Tableau criteria (i.e. with too-complex Pydantic models). We could display a warning message at the top of the landing page to the effect of "Some endpoints will not work with Tableau. Click here [link to user guide] to see more." In the user guide, we could display more informative message about endpoints that won't work.

@toph-allen toph-allen added the enhancement New feature or request label Sep 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant