git.iko.soy/elk
on master help sign in
Merge pull request #507 from mgold/string-docs
9716a98Evan Czaplicki
libraries/String.elm+18−4
compare with master
unifiedsplit
@@ -32,7 +32,11 @@ import Native.Show
32import Native.String
32import Native.String
33import Maybe (Maybe)
33import Maybe (Maybe)
34
34
35−{-| Check if a string is empty `(isEmpty "" == True)` -}
35+{-| Check if a string is empty.
36+
37+ isEmpty "" == True
38+ isEmpty "the world" == False
39+-}
36isEmpty : String -> Bool
40isEmpty : String -> Bool
37isEmpty = Native.String.isEmpty
41isEmpty = Native.String.isEmpty
38
42
@@ -64,7 +68,11 @@ append = Native.String.append
64concat : [String] -> String
68concat : [String] -> String
65concat = Native.String.concat
69concat = Native.String.concat
66
70
67−{-| Get the length of a string `(length "innumerable" == 11)` -}
71+{-| Get the length of a string.
72+
73+ length "innumerable" == 11
74+
75+-}
68length : String -> Int
76length : String -> Int
69length = Native.String.length
77length = Native.String.length
70
78
@@ -82,7 +90,10 @@ map = Native.String.map
82filter : (Char -> Bool) -> String -> String
90filter : (Char -> Bool) -> String -> String
83filter = Native.String.filter
91filter = Native.String.filter
84
92
93+{-| Reverse a string.
94+
85−{-| Reverse a string. `(reverse "stressed" == "desserts")` -}
95+ reverse "stressed" == "desserts"
96+-}
86reverse : String -> String
97reverse : String -> String
87reverse = Native.String.reverse
98reverse = Native.String.reverse
88
99
@@ -118,7 +129,10 @@ split = Native.String.split
118join : String -> [String] -> String
129join : String -> [String] -> String
119join = Native.String.join
130join = Native.String.join
120
131
121−{-| Repeat a string N times `(repeat 3 "ha" == "hahaha")` -}
132+{-| Repeat a string N times.
133+
134+ repeat 3 "ha" == "hahaha"
135+-}
122repeat : Int -> String -> String
136repeat : Int -> String -> String
123repeat = Native.String.repeat
137repeat = Native.String.repeat
124
138