git.iko.soy/elk
on master help sign in
Minor corrections in documentation
commitf5c0bb23c36505d4e2d9650f554efedf94c2686d authorEvan Czaplicki <info@elm-lang.org> dateMon 9 Sep 2013, 15:59 (13 years ago) parent281e8a2
3 files changed+12−8
compare with master
unifiedsplit
libraries/Basics.elm+4−3 libraries/Either.elm+7−4 libraries/Maybe.elm+1−1
libraries/Basics.elm+4−3
@@ -130,9 +130,10 @@ acos = Native.Basics.acos
130130asin : Float -> Float
131131asin = Native.Basics.asin
132132
133−{-| You probably do not want to use this. Because it takes `(y/x)` as the
134−argument there is no way to know where the negative signs come from so the
135−resulting angle is always between &pi;/2 and -&pi;/2 (in quadrants I and IV).
133+{-| You probably do not want to use this. It takes `(y/x)` as the
134+argument, so there is no way to know whether the negative signs comes from
135+the `y` or `x`. Thus, the resulting angle is always between &pi;/2 and -&pi;/2
136+(in quadrants I and IV). You probably want to use `atan2` instead.
136137-}
137138atan : Float -> Float
138139atan = Native.Basics.atan
libraries/Either.elm+7−4
@@ -3,7 +3,7 @@ module Either where
33{-| Represents any data that can take two different types.
44
55# Type and Constructors
6−@docs Either, Left, Right
6+@docs Either
77
88# Taking Eithers apart
99@docs either, isLeft, isRight
@@ -15,9 +15,12 @@ module Either where
1515
1616import List
1717
18−{-| This can also be used for error handling `(Either String a)` where
19− error messages are stored on the left, and the correct values
20− (&ldquo;right&rdquo; values) are stored on the right.
18+{-| Represents any data may take two forms. For example, a user ID may be
19+either an `Int` or a `String`.
20+
21+This can also be used for error handling `(Either String a)` where
22+error messages are stored on the left, and the correct values
23+(&ldquo;right&rdquo; values) are stored on the right.
2124-}
2225data Either a b = Left a | Right b
2326
libraries/Maybe.elm+1−1
@@ -3,7 +3,7 @@ module Maybe where
33{-| Represents an optional value.
44
55# Type and Constructors
6−@docs Maybe, Just, Nothing
6+@docs Maybe
77
88# Taking Maybes apart
99@docs maybe, isJust, isNothing