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

Confusing error message to end user #4401

Closed
humitos opened this issue Jul 18, 2018 · 2 comments
Closed

Confusing error message to end user #4401

humitos opened this issue Jul 18, 2018 · 2 comments
Assignees
Labels
Improvement Minor improvement to code

Comments

@humitos
Copy link
Member

humitos commented Jul 18, 2018

In #4071 (comment) I realized that we are saying that we have a problem parsing the YAML file but the problem is in fact in one of the options set from the web admin dashboard.

Example:

captura de pantalla_2018-07-18_10-57-36

There is no requirements_file entry in the YAML file (https://github.com/geopandas/geopandas/blob/master/readthedocs.yml) but it exists under the Admin -> Advanced Settings field form.

We need to improve this error to something more user-friendly that expresses the real error. It's not an error on parsing the YAML file. The file was parsed properly, but the problem is with one of the values from one of the fields.

@humitos humitos added the Improvement Minor improvement to code label Jul 18, 2018
@humitos humitos added this to the YAML File Completion milestone Jul 18, 2018
@stsewd
Copy link
Member

stsewd commented Jul 18, 2018

Previously we weren't checking for the requirements file of the web admin, so an error would happen in the install requirements step. I think we can catch this cases when doing #4388

@stsewd
Copy link
Member

stsewd commented Jul 19, 2018

This message comes from https://github.com/rtfd/readthedocs.org/blob/67dfae9de7be81af92bd88453427424111a6168f/readthedocs/projects/tasks.py#L424-L424, we should change to be more generic like Problem in your project configuration.

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

No branches or pull requests

2 participants