on master help sign in
Clarify docs
8f4aac5Christian Widera
libraries/Array.elm+3−3
@@ -5,7 +5,7 @@ array must have the same type. The arrays are implemented in Relaxed
5Radix Balanced-Trees for fast updating and concating.
5Radix Balanced-Trees for fast updating and concating.
6
6
7If you use more then one map or zip function on an array, consider turning it
7If you use more then one map or zip function on an array, consider turning it
8−first into a list, operating on it, and then turning it back into an array.
8+into a list before operating on it, and then turning it back into an array.
9
9
10# Basics
10# Basics
11@docs empty, length, get, safeGet, getWithDefault
11@docs empty, length, get, safeGet, getWithDefault
@@ -111,14 +111,14 @@ zipWith f a b =
111empty : Array a
111empty : Array a
112empty = Native.Array.empty
112empty = Native.Array.empty
113
113
114−{-| Push an item to the end of an array.
114+{-| Push an element to the end of an array.
115
115
116 push 3 (fromList [1,2]) == fromList [1,2,3]
116 push 3 (fromList [1,2]) == fromList [1,2,3]
117-}
117-}
118push : a -> Array a -> Array a
118push : a -> Array a -> Array a
119push = Native.Array.push
119push = Native.Array.push
120
120
121−{-| Return the value at the index. Breaks, if index is out of range. If the
121+{-| Return the element at the index. Breaks, if index is out of range. If the
122array length is unkown, use safeGet oder getWithDefault.
122array length is unkown, use safeGet oder getWithDefault.
123
123
124 get 2 (A.fromList [3,2,1]) == 1
124 get 2 (A.fromList [3,2,1]) == 1