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

Add new top-level "Notes" section

Browse Source
This commit is contained in:
Taylor Fausak 2021-05-01 19:13:36 +00:00 committed by GitHub
parent a700237426
commit 19cd609002
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/lib/Witch.hs
View File

@ -58,7 +58,9 @@ module Witch
-- ** Casting -- ** Casting
, Witch.Casting.Casting(Casting) , Witch.Casting.Casting(Casting)
-- * Motivation -- * Notes
-- ** Motivation
-- | Haskell provides many ways to convert between common types, and core -- | Haskell provides many ways to convert between common types, and core
-- libraries add even more. It can be challenging to know which function to -- libraries add even more. It can be challenging to know which function to
-- use when converting from some source type @a@ to some target type @b@. It -- use when converting from some source type @a@ to some target type @b@. It
@ -72,7 +74,7 @@ module Witch
-- by the [@From@](https://doc.rust-lang.org/std/convert/trait.From.html) -- by the [@From@](https://doc.rust-lang.org/std/convert/trait.From.html)
-- trait in Rust. -- trait in Rust.
-- * Alternatives -- ** Alternatives
-- | Many Haskell libraries already provide similar functionality. How is -- | Many Haskell libraries already provide similar functionality. How is
-- this library different? -- this library different?
-- --
@ -120,7 +122,7 @@ module Witch
-- if the conversion is possible, is it safe? For example converting a -- if the conversion is possible, is it safe? For example converting a
-- negative 'Int' into a 'Word' will overflow, which may be surprising. -- negative 'Int' into a 'Word' will overflow, which may be surprising.
-- * Instances -- ** Instances
-- | When should you add a 'Witch.Cast.Cast' (or 'Witch.TryCast.TryCast') -- | When should you add a 'Witch.Cast.Cast' (or 'Witch.TryCast.TryCast')
-- instance for some pair of types? This is a surprisingly tricky question -- instance for some pair of types? This is a surprisingly tricky question
-- to answer precisely. Instances are driven more by guidelines than rules. -- to answer precisely. Instances are driven more by guidelines than rules.
@ -149,7 +151,7 @@ module Witch
-- possible to convert from @s@ to @t@ but there are a lot of caveats, you -- possible to convert from @s@ to @t@ but there are a lot of caveats, you
-- probably should not write any instances at all. -- probably should not write any instances at all.
-- * Type applications -- ** Type applications
-- | This library is designed to be used with the [@TypeApplications@](https://downloads.haskell.org/~ghc/9.0.1/docs/html/users_guide/exts/type_applications.html) -- | This library is designed to be used with the [@TypeApplications@](https://downloads.haskell.org/~ghc/9.0.1/docs/html/users_guide/exts/type_applications.html)
-- language extension. Although it is not required for basic functionality, -- language extension. Although it is not required for basic functionality,
-- it is strongly encouraged. You can use 'Witch.Cast.cast', -- it is strongly encouraged. You can use 'Witch.Cast.cast',
@ -157,7 +159,7 @@ module Witch
-- 'Witch.Lift.liftedCast' without type applications. Everything else -- 'Witch.Lift.liftedCast' without type applications. Everything else
-- requires a type application. -- requires a type application.
-- * Ambiguous types -- ** Ambiguous types
-- | You may see @Identity@ show up in some type signatures. Anywhere you see -- | You may see @Identity@ show up in some type signatures. Anywhere you see
-- @Identity a@, you can mentally replace it with @a@. It is a type family -- @Identity a@, you can mentally replace it with @a@. It is a type family
-- used to trick GHC into requiring type applications for certain functions. -- used to trick GHC into requiring type applications for certain functions.