purescript-deprecated/purescript-symbols

Document compiler magic

kcsongor opened this issue · 1 comments

The source (and documentation) of this module doesn't make it directly clear that there's compiler magic going on in the background.
I would prefer knowing up front if a package is somehow treated specially, maybe a note in the readme?

This is what you're talking about?

For literal symbols such as "tinsel", the compiler (version 0.10.3 onwards) will automatically solve IsSymbol instances. Therefore, the following expression would evaluate to the string "tinsel":

https://github.com/paf31/24-days-of-purescript-2016/blame/0c5311d5e60cf2d98dabbefdad748e5720bc37a5/9.markdown#L65