[racket-dev] guidelines on error messages -- please send feedback

From: Shriram Krishnamurthi (sk at cs.brown.edu)
Date: Fri Jun 3 13:21:08 EDT 2011

Guillaume, Kathi and I have created a set of guidelines for writing
error messages for *SL.  For consistency, these guidelines need to be
used also by authors of libraries including Teachpacks, etc.  These
guidelines are currently being applied to all the error messages in
*SL in the core distribution.

Please review these guidelines and let us know if anything is
unclear.  We'd like to hear back from you within a week, by

Fri, June 10

We have had to compromise on the description a little to make
everything fit into a small number of pages, which we did because we
really do hope people will print these out and put them on the wall or
next to their monitor to refer to while writing code.  Therefore,
lengthy descriptions are out.

In particular, rationale is also out.  If you are curious about the
rationales for any of these things, please do ask.

After this is settled next week, we will send this to users@ and also
to edu@ to tell instructors to follow these terms.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: error message composition guidelines.pdf
Type: application/pdf
Size: 139427 bytes
Desc: not available
URL: <http://lists.racket-lang.org/dev/archive/attachments/20110603/261930c8/attachment.pdf>

Posted on the dev mailing list.