on master help sign in
Minor layout tweaks in documentation
c69ff2aEvan Czaplicki
libraries/Color.elm+19−5
@@ -1,4 +1,3 @@
1−
2module Color where
1module Color where
3
2
4{-| Library for working with colors. Includes
3{-| Library for working with colors. Includes
@@ -13,12 +12,27 @@ built-in names.
13@docs complementary
12@docs complementary
14
13
15# Gradients
14# Gradients
16−@docs linear radial
15+@docs linear, radial
17
16
18# Built-in Colors
17# Built-in Colors
19−These come from the [Tango
18+These colors come from the [Tango
20−palette](http://tango.freedesktop.org/Tango_Icon_Theme_Guidelines).
19+palette](http://tango.freedesktop.org/Tango_Icon_Theme_Guidelines)
21−@docs red, orange, yellow, green, blue, purple, brown, black, white, grey, gray, charcoal, lightRed, lightOrange, lightYellow, lightGreen, lightBlue, lightPurple, lightBrown, lightGrey, lightGray, lightCharcoal, darkRed, darkOrange, darkYellow, darkGreen, darkBlue, darkPurple, darkBrown, darkGrey, darkGray, darkCharcoal
20+which provides reasonable defaults for colors.
21+Each color comes with a light and dark version.
22+The six colors ranging from `lightGrey` to `darkCharcoal` are
23+a compatible series of shades of grey.
24+
25+### Standard
26+@docs red, orange, yellow, green, blue, purple, brown,
27+ grey, gray, charcoal, black, white
28+
29+### Light
30+@docs lightRed, lightOrange, lightYellow, lightGreen, lightBlue,
31+ lightPurple, lightBrown, lightGrey, lightGray, lightCharcoal
32+
33+### Dark
34+@docs darkRed, darkOrange, darkYellow, darkGreen, darkBlue,
35+ darkPurple, darkBrown, darkGrey, darkGray, darkCharcoal
22
36
23-}
37-}
24
38
libraries/Dict.elm+1−1
@@ -8,7 +8,7 @@ module Dict (empty,singleton,insert
8 ,toList,fromList
8 ,toList,fromList
9 ) where
9 ) where
10
10
11−{-|A dictionary mapping unique keys to values. The keys can be any comparable
11+{-| A dictionary mapping unique keys to values. The keys can be any comparable
12type. This includes `Int`, `Float`, `Time`, `Char`, `String`, and tuples or
12type. This includes `Int`, `Float`, `Time`, `Char`, `String`, and tuples or
13lists of comparable types.
13lists of comparable types.
14
14
libraries/Http.elm+8−5
@@ -1,12 +1,15 @@
1−{-| A library for asynchronous HTTP requests (AJAX). See the
1+{-| A library for asynchronous HTTP requests. See the
2[WebSocket](http://elm-lang.org/docs/WebSocket.elm) library if
2[WebSocket](http://elm-lang.org/docs/WebSocket.elm) library if
3you have very strict latency requirements.
3you have very strict latency requirements.
4
4
5−# Types
5+# Sending Requests
6−@docs Request, Response
6+@docs send, sendGet
7
7
8−# Making requests
8+# Creating Requests
9−@docs request, get, post, send, sendGet
9+@docs get, post, request
10+
11+# Responses
12+@docs Response
10
13
11-}
14-}
12
15
libraries/Set.elm+3−3
@@ -6,9 +6,9 @@ module Set (empty,singleton,insert,remove
6 ,toList,fromList
6 ,toList,fromList
7 ) where
7 ) where
8
8
9−{-|A set of unique values. The values can be any comparable type. This includes
9+{-| A set of unique values. The values can be any comparable type. This
10−`Int`, `Float`, `Time`, `Char`, `String`, and tuples or lists of comparable
10+includes `Int`, `Float`, `Time`, `Char`, `String`, and tuples or lists
11−types.
11+of comparable types.
12
12
13Insert, remove, and query operations all take *O(log n)* time.
13Insert, remove, and query operations all take *O(log n)* time.
14
14
libraries/Text.elm+8−5
@@ -3,14 +3,17 @@ module Text where
3
3
4{-| Functions for displaying text
4{-| Functions for displaying text
5
5
6−# Constructors
6+# Creating Text
7@docs toText
7@docs toText
8
8
9−# Stylizing and displaying Text
9+# Creating Elements
10−@docs typeface, monospace, header, link, height, color, bold, italic, overline, underline, strikethrough, justified, centered, righted, text, plaintext
10+@docs plainText, asText, text, centered, justified, righted
11
11
12−# Converting other elements to Text
12+# Formatting
13−@docs asText
13+@docs color, typeface, height, link
14+
15+# Simple Formatting
16+@docs monospace, header, bold, italic, underline, overline, strikethrough
14
17
15-}
18-}
16
19
libraries/Time.elm+10−4
@@ -1,10 +1,16 @@
1module Time where
1module Time where
2
2
3−{-| Library for working with time. Type `Time` represents some number of
3+{-| Library for working with time.
4−milliseconds.
5
4
6−# Type and Constructors
5+# Units
7−@docs Time, millisecond, fps, fpsWhen, every, since, timestamp, delay
6+@docs Time, millisecond, second, minute, hour,
7+ inMilliseconds, inSeconds, inMinutes, inHours
8+
9+# Tickers
10+@docs fps, fpsWhen, every
11+
12+# Timing
13+@docs timestamp, delay, since
8
14
9-}
15-}
10
16