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 error messages #246

Open
1 of 2 tasks
spencerkclark opened this issue Dec 6, 2017 · 2 comments
Open
1 of 2 tasks

Improve error messages #246

spencerkclark opened this issue Dec 6, 2017 · 2 comments

Comments

@spencerkclark
Copy link
Collaborator

spencerkclark commented Dec 6, 2017

I have come to notice that minor mistakes in the setup of one's object library can lead to pretty inscrutable error messages, which make it difficult for new users to figure out what might have gone wrong (frequently diagnosing the issue requires knowledge of aospy's internals). In many cases, it shouldn't have to be this way.

Two that I've recently come across are:

  • Having a calculation function that returns a numpy array rather than a DataArray; this should be easy to validate (and we can raise an informative error in this instance)
  • Having a DataLoader that points to files that do not exist; we should print out what file names the DataLoader was looking for so that the user can try and correct say a typo in their DataLoader definition.

I'm guessing there are others, which we can add to this list as they come up.

@spencerahill
Copy link
Owner

Totally agree. #136 is related for DataLoaders.

@spencerahill
Copy link
Owner

#277 addressed the second of these for GFDLDataLoaders

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

No branches or pull requests

2 participants