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

Add link to hosted plugin documentation on ParserError #100

Closed
anders-kiaer opened this issue Sep 26, 2019 · 1 comment · Fixed by #456
Closed

Add link to hosted plugin documentation on ParserError #100

anders-kiaer opened this issue Sep 26, 2019 · 1 comment · Fixed by #456
Labels
enhancement 🚀 New feature or request

Comments

@anders-kiaer
Copy link
Collaborator

anders-kiaer commented Sep 26, 2019

When plugins are missing a required argument, or it is of the wrong type, the user is currently provided by a decent error message. Example:

Traceback (most recent call last):
[...]
webviz_config._config_parser.ParserError: The plugin `DataTable` requires the argument `csv_file` in your configuration file.

This could perhaps be further improved by also giving a URL to hosted plugin documentation (if available from the setup.py install script and project_urls["Documentation"]).

@anders-kiaer anders-kiaer added the enhancement 🚀 New feature or request label Sep 26, 2019
@anders-kiaer anders-kiaer changed the title Add link to hosted container documentation on ParserError Add link to hosted plugin documentation on ParserError Jan 13, 2020
@anders-kiaer
Copy link
Collaborator Author

This issue can now probably be closed if we simply add + encourage the user to run webviz docs in the error message.

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
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant