Improve multiple error messages #20618
Closed
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
tau-dev
changed the title
gooncreeper
reviewed
Jul 16, 2024
src/Sema.zig
Outdated
| => try sema.errNote(src_loc, msg, "type has no guaranteed in-memory representation", .{}), | ||
| .Array => try sema.errNote(src_loc, msg, "packed fields are ordered according to machine endianness, array elements are not", .{}), |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
There was a problem hiding this comment.
Note that this is just a note on the packed structs cannot contain fields of type '[4]u32' error message; adding "arrays are not allowed in packed structs" would be redundant.
The reason for it not being allowed, on the other hand, is rather subtle, and I think explaining it helps the user understand whether they want to solve the error by giving up packed-ness or array-ness. As far as I can tell, the reason #12547 is still open is that the status quo error message saying only "this isn't allowed" is not useful to new users.
tau-dev
force-pushed
the
improve-parser
branch
2 times, most recently
from
b76224d to
6624dc0
Compare
Fixes ziglang#14334: non-tuples are more common, and forgetting a type or name from a struct field is an easier mistake to make than adding a name to a tuple field. Also addresses ziglang#18597 (the specific case presented there, but not the general goal of that issue) by checking for mismatched parentheses after a parser error. Unclosed parens can cause otherwise much-more-cryptic errors.
Closes ziglang#12547: explain why arrays aren't allowed in packed structs. Closes ziglang#13832: improve error message for a common mistake on the LHS of the binary `!` operator.
While we can't cover every I/O function like this, lockStdErr covers std.debug.print and std.log.*, probably the most important places to leave a useful hint for newcomers to Zig.
andrewrk
requested changes
Jul 21, 2024
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.
Fixes #12547.
Fixes #12829.
Fixes #13832.
Fixes #14334.
Fixes #16019.
Fixes #16702.
Fixes #14238.
None of these are particularly related, I can pull them into separate PRs if necessary.