From c69ff2a10b246865584bc9563298b8a919d4f148 Mon Sep 17 00:00:00 2001 From: Evan Czaplicki Date: Mon, 9 Sep 2013 23:07:49 -0700 Subject: [PATCH] Minor layout tweaks in documentation --- libraries/Color.elm | 24 +++++++++++++++++++----- libraries/Dict.elm | 2 +- libraries/Http.elm | 13 ++++++++----- libraries/Set.elm | 6 +++--- libraries/Text.elm | 13 ++++++++----- libraries/Time.elm | 14 ++++++++++---- 6 files changed, 49 insertions(+), 23 deletions(-) diff --git a/libraries/Color.elm b/libraries/Color.elm index 8310c00..cbebbf6 100644 --- a/libraries/Color.elm +++ b/libraries/Color.elm @@ -1,4 +1,3 @@ - module Color where {-| Library for working with colors. Includes @@ -13,12 +12,27 @@ built-in names. @docs complementary # Gradients -@docs linear radial +@docs linear, radial # Built-in Colors -These come from the [Tango -palette](http://tango.freedesktop.org/Tango_Icon_Theme_Guidelines). -@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 +These colors come from the [Tango +palette](http://tango.freedesktop.org/Tango_Icon_Theme_Guidelines) +which provides reasonable defaults for colors. +Each color comes with a light and dark version. +The six colors ranging from `lightGrey` to `darkCharcoal` are +a compatible series of shades of grey. + +### Standard +@docs red, orange, yellow, green, blue, purple, brown, + grey, gray, charcoal, black, white + +### Light +@docs lightRed, lightOrange, lightYellow, lightGreen, lightBlue, + lightPurple, lightBrown, lightGrey, lightGray, lightCharcoal + +### Dark +@docs darkRed, darkOrange, darkYellow, darkGreen, darkBlue, + darkPurple, darkBrown, darkGrey, darkGray, darkCharcoal -} diff --git a/libraries/Dict.elm b/libraries/Dict.elm index 735db8e..c542e45 100644 --- a/libraries/Dict.elm +++ b/libraries/Dict.elm @@ -8,7 +8,7 @@ module Dict (empty,singleton,insert ,toList,fromList ) where -{-|A dictionary mapping unique keys to values. The keys can be any comparable +{-| A dictionary mapping unique keys to values. The keys can be any comparable type. This includes `Int`, `Float`, `Time`, `Char`, `String`, and tuples or lists of comparable types. diff --git a/libraries/Http.elm b/libraries/Http.elm index bb85878..61810f8 100644 --- a/libraries/Http.elm +++ b/libraries/Http.elm @@ -1,12 +1,15 @@ -{-| A library for asynchronous HTTP requests (AJAX). See the +{-| A library for asynchronous HTTP requests. See the [WebSocket](http://elm-lang.org/docs/WebSocket.elm) library if you have very strict latency requirements. -# Types -@docs Request, Response +# Sending Requests +@docs send, sendGet -# Making requests -@docs request, get, post, send, sendGet +# Creating Requests +@docs get, post, request + +# Responses +@docs Response -} diff --git a/libraries/Set.elm b/libraries/Set.elm index 8472de2..19a736e 100644 --- a/libraries/Set.elm +++ b/libraries/Set.elm @@ -6,9 +6,9 @@ module Set (empty,singleton,insert,remove ,toList,fromList ) where -{-|A set of unique values. The values can be any comparable type. This includes -`Int`, `Float`, `Time`, `Char`, `String`, and tuples or lists of comparable -types. +{-| A set of unique values. The values can be any comparable type. This +includes `Int`, `Float`, `Time`, `Char`, `String`, and tuples or lists +of comparable types. Insert, remove, and query operations all take *O(log n)* time. diff --git a/libraries/Text.elm b/libraries/Text.elm index 582392b..85c9285 100644 --- a/libraries/Text.elm +++ b/libraries/Text.elm @@ -3,14 +3,17 @@ module Text where {-| Functions for displaying text -# Constructors +# Creating Text @docs toText -# Stylizing and displaying Text -@docs typeface, monospace, header, link, height, color, bold, italic, overline, underline, strikethrough, justified, centered, righted, text, plaintext +# Creating Elements +@docs plainText, asText, text, centered, justified, righted -# Converting other elements to Text -@docs asText +# Formatting +@docs color, typeface, height, link + +# Simple Formatting +@docs monospace, header, bold, italic, underline, overline, strikethrough -} diff --git a/libraries/Time.elm b/libraries/Time.elm index 47a2fb1..2df15f6 100644 --- a/libraries/Time.elm +++ b/libraries/Time.elm @@ -1,10 +1,16 @@ module Time where -{-| Library for working with time. Type `Time` represents some number of -milliseconds. +{-| Library for working with time. -# Type and Constructors -@docs Time, millisecond, fps, fpsWhen, every, since, timestamp, delay +# Units +@docs Time, millisecond, second, minute, hour, + inMilliseconds, inSeconds, inMinutes, inHours + +# Tickers +@docs fps, fpsWhen, every + +# Timing +@docs timestamp, delay, since -}