language-servers/roc
1
0
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2025-08-04 04:08:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Update some error macro docs

Browse source
This commit is contained in:
Richard Feldman 2024-06-30 08:18:49 -04:00
parent f0f8d76055
commit 1caebcff56
No known key found for this signature in database
GPG key ID: F1F21AA5B1D9E43B
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
crates/error_macros/src/lib.rs
View file

@ -101,7 +101,8 @@ pub const INTERNAL_ERROR_MESSAGE: &str = concat!(
);
/// `internal_error!` should be used whenever a compiler invariant is broken.
/// It is a wrapper around panic that tells the user to file a bug.
/// It tells the user to file a bug and then exits the program with a nonzero exit code.
/// (On wasm it doesn't tell the user anything, since we don't necessarily have a way to print.)
/// This should only be used in cases where there would be a compiler bug and the user can't fix it.
/// If there is simply an unimplemented feature, please use `unimplemented!`
/// If there is a user error, please use roc_reporting to print a nice error message.