on master help sign in
Minor corrections in documentation
f5c0bb2Evan Czaplicki
libraries/Basics.elm+4−3
@@ -130,9 +130,10 @@ acos = Native.Basics.acos
130asin : Float -> Float
130asin : Float -> Float
131asin = Native.Basics.asin
131asin = Native.Basics.asin
132
132
133−{-| You probably do not want to use this. Because it takes `(y/x)` as the
133+{-| You probably do not want to use this. It takes `(y/x)` as the
134−argument there is no way to know where the negative signs come from so the
134+argument, so there is no way to know whether the negative signs comes from
135−resulting angle is always between π/2 and -π/2 (in quadrants I and IV).
135+the `y` or `x`. Thus, the resulting angle is always between π/2 and -π/2
136+(in quadrants I and IV). You probably want to use `atan2` instead.
136-}
137-}
137atan : Float -> Float
138atan : Float -> Float
138atan = Native.Basics.atan
139atan = Native.Basics.atan
libraries/Either.elm+7−4
@@ -3,7 +3,7 @@ module Either where
3{-| Represents any data that can take two different types.
3{-| Represents any data that can take two different types.
4
4
5# Type and Constructors
5# Type and Constructors
6−@docs Either, Left, Right
6+@docs Either
7
7
8# Taking Eithers apart
8# Taking Eithers apart
9@docs either, isLeft, isRight
9@docs either, isLeft, isRight
@@ -15,9 +15,12 @@ module Either where
15
15
16import List
16import List
17
17
18+{-| Represents any data may take two forms. For example, a user ID may be
19+either an `Int` or a `String`.
20+
18−{-| This can also be used for error handling `(Either String a)` where
21+This can also be used for error handling `(Either String a)` where
19− error messages are stored on the left, and the correct values
22+error messages are stored on the left, and the correct values
20− (“right” values) are stored on the right.
23+(“right” values) are stored on the right.
21-}
24-}
22data Either a b = Left a | Right b
25data Either a b = Left a | Right b
23
26
libraries/Maybe.elm+1−1
@@ -3,7 +3,7 @@ module Maybe where
3{-| Represents an optional value.
3{-| Represents an optional value.
4
4
5# Type and Constructors
5# Type and Constructors
6−@docs Maybe, Just, Nothing
6+@docs Maybe
7
7
8# Taking Maybes apart
8# Taking Maybes apart
9@docs maybe, isJust, isNothing
9@docs maybe, isJust, isNothing