git.iko.soy/elk
on master help sign in
Make docs nicer
commit463873b771cdd6bc3e3061b26b66409fad890dc7 authorEvan Czaplicki <info@elm-lang.org> dateTue 22 Oct 2013, 10:09 (13 years ago) parentf1b1bcd
5 files changed+13−14
compare with master
unifiedsplit
libraries/Color.elm+1−1 libraries/Graphics/Collage.elm+1−1 libraries/Graphics/Element.elm+7−8 libraries/JavaScript.elm+1−1 libraries/Signal.elm+3−3
libraries/Color.elm+1−1
@@ -6,7 +6,7 @@ module Color where
66built-in names.
77
88# Creation
9−@docs rgb, rgba, hsv, hsva, grayscale, greyscale
9+@docs rgb, rgba, hsv, hsva, greyscale, grayscale
1010
1111# From Other Colors
1212@docs complement
libraries/Graphics/Collage.elm+1−1
@@ -125,7 +125,7 @@ tiled to fill the entire shape.
125125textured : String -> Shape -> Form
126126textured src shape = fill (Texture src) shape
127127
128−{-| Fill a shape with a [gradient](/docs/Color.elm#linear). -}
128+{-| Fill a shape with a [gradient](/library/Color.elm#linear). -}
129129gradient : Gradient -> Shape -> Form
130130gradient grad shape = fill (Grad grad) shape
131131
libraries/Graphics/Element.elm+7−8
@@ -204,9 +204,8 @@ flow dir es =
204204 DIn -> newFlow (List.maximum ws) (List.maximum hs)
205205 DOut -> newFlow (List.maximum ws) (List.maximum hs)
206206
207−{-| Stack elements vertically. To put `a` above `b` you would say:
208−
209− a `above` b
207+{-| Stack elements vertically.
208+To put `a` above `b` you would say: ``a `above` b``
210209-}
211210above : Element -> Element -> Element
212211above hi lo =
@@ -214,9 +213,8 @@ above hi lo =
214213 (heightOf hi + heightOf lo)
215214 (Flow DDown [hi,lo])
216215
217−{-| Stack elements vertically. To put `a` below `b` you would say:
218−
219− a `below` b
216+{-| Stack elements vertically.
217+To put `a` below `b` you would say: ``a `below` b``
220218-}
221219below : Element -> Element -> Element
222220below lo hi =
@@ -225,6 +223,7 @@ below lo hi =
225223 (Flow DDown [hi,lo])
226224
227225{-| Put elements beside each other horizontally.
226+To put `a` beside `b` you would say: ``a `beside` b``
228227-}
229228beside : Element -> Element -> Element
230229beside lft rht =
@@ -232,8 +231,8 @@ beside lft rht =
232231 (max (heightOf lft) (heightOf rht))
233232 (Flow right [lft,rht])
234233
235−{-| Layer elements on top of each other, starting from the bottom.
236−`(layers == flow outward)`
234+{-| Layer elements on top of each other, starting from the bottom:
235+`layers == flow outward`
237236-}
238237layers : [Element] -> Element
239238layers es =
libraries/JavaScript.elm+1−1
@@ -9,7 +9,7 @@ integration.
99@docs toString, toInt, toFloat, toBool, toList
1010
1111# JavaScript from Elm
12−@docs fromString, fromInt, fromFloat, fromBool fromList
12+@docs fromString, fromInt, fromFloat, fromBool, fromList
1313-}
1414{-
1515# DOM Nodes and Elements
libraries/Signal.elm+3−3
@@ -15,15 +15,15 @@ the [`Time`](/docs/Signal/Time.elm) library.
1515# Combine
1616@docs constant, lift, lift2, merge, merges, combine
1717
18−# Pretty Lift
19−@docs (<~), (~)
20−
2118# Past-Dependence
2219@docs foldp, count, countIf
2320
2421#Filters
2522@docs keepIf, dropIf, keepWhen, dropWhen, dropRepeats, sampleOn
2623
24+# Pretty Lift
25+@docs (<~), (~)
26+
2727# Do you even lift?
2828@docs lift3, lift4, lift5, lift6, lift7, lift8
2929