updating rust package documentation

This commit is contained in:
Luke Boswell 2022-11-03 20:00:06 +11:00
parent f0d6e418fa
commit f3bdb5f321
No known key found for this signature in database
GPG key ID: 0E908525B2C7BD68
98 changed files with 140 additions and 15 deletions

View file

@ -1,3 +1,4 @@
//! Provides macros for consistent reporting of errors in Roc's rust code.
/// `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.
/// This should only be used in cases where there would be a compiler bug and the user can't fix it.