1531559 · rowtype-yoga/purescript-native

git.iko.soy/rowtype-yoga/purescript-native

Merge pull request #2501 from purescript/prim-docs-update

Update docs for the Partial type class

commit1531559693a16e8c08d47d398e006100aba3f920 authorPhil Freeman <paf31@cantab.net> dateSat 24 Dec 2016, 09:12 (10 years ago) parentac1d1e1 b3c889b

1 file changed+5−2

unifiedsplit

src/Language/PureScript/Docs/Prim.hs+5−2

@@ -172,8 +172,11 @@ boolean = primType "Boolean" $ unlines

172172partial :: Declaration

173173partial = primClass "Partial" $ unlines

174174 [ "The Partial type class is used to indicate that a function is *partial,*"

175− , "that is, it will throw an error for some inputs. For more information,"

176− , "see [the Partial type class guide](https://github.com/purescript/documentation/blob/master/guides/The-Partial-type-class.md)."

175+ , "that is, it is not defined for all inputs. In practice, attempting to use"

176+ , "a partial function with a bad input will usually cause an error to be"

177+ , "thrown, although it is not safe to assume that this will happen in all"

178+ , "cases. For more information, see"

179+ , "[the Partial type class guide](https://github.com/purescript/documentation/blob/master/guides/The-Partial-type-class.md)."

177180 ]

178181

179182fail :: Declaration