tfausak/witch
1
1
Fork 0
mirror of https://github.com/tfausak/witch.git synced 2024-11-22 14:58:13 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation to unsafe section

Browse Source
This commit is contained in:
Taylor Fausak 2021-05-01 19:04:27 +00:00 committed by GitHub
parent c1c69ef332
commit 6f1c2e671a
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/lib/Witch.hs
View File

@ -26,6 +26,13 @@ module Witch
, Witch.Utility.tryVia
-- ** Unsafe
-- | These functions should only be used in two circumstances: When you know
-- a conversion is safe even though you can't prove it to the compiler, and
-- when you're alright with your program crashing if the conversion fails.
-- In all other cases you should prefer the normal conversion functions like
-- 'Witch.Cast.cast'. And if you're converting a literal value, consider
-- using the Template Haskell conversion functions like
-- 'Witch.Lift.liftedCast'.
, Witch.Utility.unsafeCast
, Witch.Utility.unsafeFrom
, Witch.Utility.unsafeInto