-
Notifications
You must be signed in to change notification settings - Fork 799
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
Make error messages on typos and missing/incorrect data types more informative #2824
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d require colons in field names to be escaped
…colon in a column name
mattijn
reviewed
Jan 13, 2023
mattijn
reviewed
Jan 14, 2023
@mattijn How do you think we should proceed here? I think the improved error messages would be nice to have in the release candidate. |
mattijn
reviewed
Feb 21, 2023
mattijn
approved these changes
Feb 21, 2023
Merging in this too, yay better error messages everywhere! |
binste
added a commit
to binste/altair
that referenced
this pull request
Feb 23, 2023
joelostblom
pushed a commit
that referenced
this pull request
Feb 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When trying to reference a column from a dataframe and a typo is made, the error message suggests that there is an issue with the type specification rather than the column name itself:
Old error
I think that message is incorrect and unhelpful, and I often see learners struggle with understanding that they have made a typo. This PR suggests replacing the error message with this more informative alternative:
New error
Similarly, when making a typo in the encoding data type, the error message could also be made more informative:
This PR changes that to the following:
New error
Note that this second change means that it is now required to escape colons in column names and although this is is a breaking change I think it makes it more consistent instead of having colon in column names sometimes work depending on whether the part after the colon happens to equal an Altair data type or not.