git.iko.soy/elk
on master help sign in
Minor layout tweaks in documentation
commitc69ff2a10b246865584bc9563298b8a919d4f148 authorEvan Czaplicki <info@elm-lang.org> dateMon 9 Sep 2013, 23:07 (13 years ago) parent66add54
6 files changed+49−23
compare with master
unifiedsplit
libraries/Color.elm+19−5 libraries/Dict.elm+1−1 libraries/Http.elm+8−5 libraries/Set.elm+3−3 libraries/Text.elm+8−5 libraries/Time.elm+10−4
libraries/Color.elm+19−5
@@ -1,4 +1,3 @@
1−
21module Color where
32
43{-| Library for working with colors. Includes
@@ -13,12 +12,27 @@ built-in names.
1312@docs complementary
1413
1514# Gradients
16−@docs linear radial
15+@docs linear, radial
1716
1817# Built-in Colors
19−These come from the [Tango
20−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
18+These colors come from the [Tango
19+palette](http://tango.freedesktop.org/Tango_Icon_Theme_Guidelines)
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
2236
2337-}
2438
libraries/Dict.elm+1−1
@@ -8,7 +8,7 @@ module Dict (empty,singleton,insert
88 ,toList,fromList
99 ) where
1010
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
1212type. This includes `Int`, `Float`, `Time`, `Char`, `String`, and tuples or
1313lists of comparable types.
1414
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
22[WebSocket](http://elm-lang.org/docs/WebSocket.elm) library if
33you have very strict latency requirements.
44
5−# Types
6−@docs Request, Response
5+# Sending Requests
6+@docs send, sendGet
77
8−# Making requests
9−@docs request, get, post, send, sendGet
8+# Creating Requests
9+@docs get, post, request
10+
11+# Responses
12+@docs Response
1013
1114-}
1215
libraries/Set.elm+3−3
@@ -6,9 +6,9 @@ module Set (empty,singleton,insert,remove
66 ,toList,fromList
77 ) where
88
9−{-|A set of unique values. The values can be any comparable type. This includes
10−`Int`, `Float`, `Time`, `Char`, `String`, and tuples or lists of comparable
11−types.
9+{-| A set of unique values. The values can be any comparable type. This
10+includes `Int`, `Float`, `Time`, `Char`, `String`, and tuples or lists
11+of comparable types.
1212
1313Insert, remove, and query operations all take *O(log n)* time.
1414
libraries/Text.elm+8−5
@@ -3,14 +3,17 @@ module Text where
33
44{-| Functions for displaying text
55
6−# Constructors
6+# Creating Text
77@docs toText
88
9−# Stylizing and displaying Text
10−@docs typeface, monospace, header, link, height, color, bold, italic, overline, underline, strikethrough, justified, centered, righted, text, plaintext
9+# Creating Elements
10+@docs plainText, asText, text, centered, justified, righted
1111
12−# Converting other elements to Text
13−@docs asText
12+# Formatting
13+@docs color, typeface, height, link
14+
15+# Simple Formatting
16+@docs monospace, header, bold, italic, underline, overline, strikethrough
1417
1518-}
1619
libraries/Time.elm+10−4
@@ -1,10 +1,16 @@
11module Time where
22
3−{-| Library for working with time. Type `Time` represents some number of
4−milliseconds.
3+{-| Library for working with time.
54
6−# Type and Constructors
7−@docs Time, millisecond, fps, fpsWhen, every, since, timestamp, delay
5+# Units
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
814
915-}
1016