git.iko.soy/rowtype-yoga/purescript-native
on golang help sign in
Update docs
commit78065b65278a1e5d18401ccc8893af5b48bf7530 authorPhil Freeman <paf31@cantab.net> dateTue 4 Mar 2014, 16:28 (13 years ago) parent003b447
2 files changed+190−102
docs/source/prelude.rst+100−52 prelude/README.md+90−50
docs/source/prelude.rst+100−52
@@ -7,11 +7,6 @@ Module Prelude
77Types
88~~~~~
99
10−::
11−
12− data Ref a where
13− Ref :: a -> Ref a
14−
1510Type Classes
1611~~~~~~~~~~~~
1712
@@ -80,41 +75,39 @@ Type Class Instances
8075
8176::
8277
83− (Monad (m)) => instance Applicative m
78+ (Monad ((m))) => instance applicativeFromMonad :: Applicative (m)
8479
85− instance Bits Prim.Number
80+ instance bitsNumber :: Bits (Prim.Number)
8681
87− instance BoolLike Prim.Boolean
82+ instance boolLikeBoolean :: BoolLike (Prim.Boolean)
8883
89− instance Category Prim.Function
84+ instance categoryArr :: Category (Prim.Function)
9085
91− instance Eq Ref a
86+ (Eq ((a))) => instance eqArray :: Eq ([a])
9287
93− instance Eq Prim.String
88+ instance eqBoolean :: Eq (Prim.Boolean)
9489
95− instance Eq Prim.Number
90+ instance eqNumber :: Eq (Prim.Number)
9691
97− instance Eq Prim.Boolean
92+ instance eqString :: Eq (Prim.String)
9893
99− (Eq (a)) => instance Eq [a]
94+ (Applicative ((f))) => instance functorFromApplicative :: Functor (f)
10095
101− (Applicative (f)) => instance Functor f
96+ instance numNumber :: Num (Prim.Number)
10297
103− instance Num Prim.Number
98+ instance ordNumber :: Ord (Prim.Number)
10499
105− instance Ord Prim.Number
100+ instance readBoolean :: Read (Prim.Boolean)
106101
107− instance Prelude.Show Prim.Number
102+ instance readNumber :: Read (Prim.Number)
108103
109− instance Read Prim.String
104+ instance readString :: Read (Prim.String)
110105
111− instance Read Prim.Boolean
106+ instance showBoolean :: Show (Prim.Boolean)
112107
113− instance Read Prim.Number
108+ instance showNumber :: Show (Prim.Number)
114109
115− instance Show Prim.String
116−
117− instance Show Prim.Boolean
110+ instance showString :: Show (Prim.String)
118111
119112Values
120113~~~~~~
@@ -139,8 +132,6 @@ Values
139132
140133 flip :: forall c. forall b. forall a. (a -> b -> c) -> b -> a -> c
141134
142− liftRef :: forall b. forall a. (a -> a -> b) -> Ref a -> Ref a -> b
143−
144135 numAdd :: Prim.Number -> Prim.Number -> Prim.Number
145136
146137 numAnd :: Prim.Number -> Prim.Number -> Prim.Number
@@ -175,13 +166,9 @@ Values
175166
176167 numZshr :: Prim.Number -> Prim.Number -> Prim.Number
177168
178− readNumber :: Prim.String -> Prim.Number
169+ readNumberImpl :: Prim.String -> Prim.Number
179170
180− refEq :: forall a. Ref a -> Ref a -> Prim.Boolean
181−
182− refIneq :: forall a. Ref a -> Ref a -> Prim.Boolean
183−
184− showNumber :: Prim.Number -> Prim.String
171+ showNumberImpl :: Prim.Number -> Prim.String
185172
186173 unsafeRefEq :: forall a. a -> a -> Prim.Boolean
187174
@@ -207,9 +194,9 @@ Type Class Instances
207194
208195::
209196
210− instance Monoid Prim.String
197+ instance monoidArray :: Monoid ([a])
211198
212− instance Monoid [a]
199+ instance monoidString :: Monoid (Prim.String)
213200
214201Values
215202~~~~~~
@@ -251,6 +238,8 @@ Values
251238
252239 when :: forall m. (Monad (m)) => Prim.Boolean -> m { } -> m { }
253240
241+ zipWithM :: forall c. forall b. forall a. forall m. (Monad (m)) => (a -> b -> m c) -> [a] -> [b] -> m [c]
242+
254243Module Data.Maybe
255244-----------------
256245
@@ -271,13 +260,13 @@ Type Class Instances
271260
272261::
273262
274− instance Prelude.Applicative Maybe
263+ instance applicativeMaybe :: Applicative (Maybe)
275264
276− instance Prelude.Functor Maybe
265+ instance functorMaybe :: Functor (Maybe)
277266
278− instance Prelude.Monad Maybe
267+ instance monadMaybe :: Monad (Maybe)
279268
280− (Show (a)) => instance Prelude.Show Maybe a
269+ (Show ((a))) => instance showMaybe :: Show (Maybe a)
281270
282271Values
283272~~~~~~
@@ -308,13 +297,13 @@ Type Class Instances
308297
309298::
310299
311− instance Prelude.Applicative Either e
300+ instance applicativeEither :: Applicative (Either e)
312301
313− instance Prelude.Functor Either a
302+ instance functorEither :: Functor (Either a)
314303
315− instance Prelude.Monad Either e
304+ instance monadEither :: Monad (Either e)
316305
317− (Show (a),Show (b)) => instance Prelude.Show Either a b
306+ (Show ((a)),Show ((b))) => instance showEither :: Show (Either a b)
318307
319308Values
320309~~~~~~
@@ -337,13 +326,13 @@ Type Class Instances
337326
338327::
339328
340− instance Prelude.Alternative Prim.Array
329+ instance alternativeArray :: Alternative (Prim.Array)
341330
342− instance Prelude.Functor Prim.Array
331+ instance functorArray :: Functor (Prim.Array)
343332
344− instance Prelude.Monad Prim.Array
333+ instance monadArray :: Monad (Prim.Array)
345334
346− (Prelude.Show (a)) => instance Prelude.Show [a]
335+ (Show ((a))) => instance showArray :: Show ([a])
347336
348337Values
349338~~~~~~
@@ -360,11 +349,15 @@ Values
360349
361350 concatMap :: forall b. forall a. [a] -> (a -> [b]) -> [b]
362351
352+ deleteAt :: forall a. Prim.Number -> Prim.Number -> [a] -> [a]
353+
354+ drop :: forall a. Prim.Number -> [a] -> [a]
355+
363356 filter :: forall a. (a -> Prim.Boolean) -> [a] -> [a]
364357
365358 find :: forall a. (a -> Prim.Boolean) -> [a] -> Maybe a
366359
367− foldl :: forall b. forall a. (a -> b -> b) -> b -> [a] -> b
360+ foldl :: forall b. forall a. (b -> a -> b) -> b -> [a] -> b
368361
369362 foldr :: forall b. forall a. (a -> b -> a) -> a -> [b] -> a
370363
@@ -372,6 +365,8 @@ Values
372365
373366 indexOf :: forall a. [a] -> a -> Prim.Number
374367
368+ insertAt :: forall a. Prim.Number -> a -> [a] -> [a]
369+
375370 isEmpty :: forall a. [a] -> Prim.Boolean
376371
377372 joinS :: [Prim.String] -> Prim.String
@@ -398,12 +393,46 @@ Values
398393
399394 sort :: forall a. [a] -> [a]
400395
401− splice :: forall a. Prim.Number -> Prim.Number -> [a] -> [a] -> [a]
402−
403396 tail :: forall a. [a] -> Maybe [a]
404397
398+ take :: forall a. Prim.Number -> [a] -> [a]
399+
400+ updateAt :: forall a. Prim.Number -> a -> [a] -> [a]
401+
405402 zipWith :: forall c. forall b. forall a. (a -> b -> c) -> [a] -> [b] -> [c]
406403
404+Module Data.Eq
405+--------------
406+
407+Types
408+~~~~~
409+
410+::
411+
412+ data Ref a where
413+ Ref :: a -> Ref a
414+
415+Type Classes
416+~~~~~~~~~~~~
417+
418+Type Class Instances
419+~~~~~~~~~~~~~~~~~~~~
420+
421+::
422+
423+ instance eqRef :: Eq (Ref a)
424+
425+Values
426+~~~~~~
427+
428+::
429+
430+ liftRef :: forall b. forall a. (a -> a -> b) -> Ref a -> Ref a -> b
431+
432+ refEq :: forall a. Ref a -> Ref a -> Prim.Boolean
433+
434+ refIneq :: forall a. Ref a -> Ref a -> Prim.Boolean
435+
407436Module Data.Array.Unsafe
408437------------------------
409438
@@ -444,7 +473,7 @@ Type Class Instances
444473
445474::
446475
447− (Prelude.Show (a),Prelude.Show (b)) => instance Prelude.Show Tuple a b
476+ (Show ((a)),Show ((b))) => instance showTuple :: Show (Tuple a b)
448477
449478Values
450479~~~~~~
@@ -663,7 +692,7 @@ Type Class Instances
663692
664693::
665694
666− instance Prelude.Monad Eff e
695+ instance monadEff :: Monad (Eff e)
667696
668697Values
669698~~~~~~
@@ -684,6 +713,25 @@ Values
684713
685714 whileE :: forall a. forall e. Eff e Prim.Boolean -> Eff e a -> Eff e { }
686715
716+Module Control.Monad.Eff.Unsafe
717+-------------------------------
718+
719+Types
720+~~~~~
721+
722+Type Classes
723+~~~~~~~~~~~~
724+
725+Type Class Instances
726+~~~~~~~~~~~~~~~~~~~~
727+
728+Values
729+~~~~~~
730+
731+::
732+
733+ unsafeInterleaveEff :: forall a. forall eff2. forall eff1. Eff eff1 a -> Eff eff2 a
734+
687735Module Random
688736-------------
689737
@@ -786,7 +834,7 @@ Values
786834
787835::
788836
789− print :: forall r. forall a. (Prelude.Show (a)) => a -> Eff (trace :: Trace | r) { }
837+ print :: forall r. forall a. (Show (a)) => a -> Eff (trace :: Trace | r) { }
790838
791839 trace :: forall r. Prim.String -> Eff (trace :: Trace | r) { }
792840
prelude/README.md+90−50
@@ -3,9 +3,6 @@
33
44### Types
55
6− data Ref a where
7− Ref :: a -> Ref a
8−
96
107### Type Classes
118
@@ -70,41 +67,39 @@
7067
7168### Type Class Instances
7269
73− (Monad (m)) => instance Applicative m
74−
75− instance Bits Prim.Number
70+ (Monad ((m))) => instance applicativeFromMonad :: Applicative (m)
7671
77− instance BoolLike Prim.Boolean
72+ instance bitsNumber :: Bits (Prim.Number)
7873
79− instance Category Prim.Function
74+ instance boolLikeBoolean :: BoolLike (Prim.Boolean)
8075
81− instance Eq Ref a
76+ instance categoryArr :: Category (Prim.Function)
8277
83− instance Eq Prim.String
78+ (Eq ((a))) => instance eqArray :: Eq ([a])
8479
85− instance Eq Prim.Number
80+ instance eqBoolean :: Eq (Prim.Boolean)
8681
87− instance Eq Prim.Boolean
82+ instance eqNumber :: Eq (Prim.Number)
8883
89− (Eq (a)) => instance Eq [a]
84+ instance eqString :: Eq (Prim.String)
9085
91− (Applicative (f)) => instance Functor f
86+ (Applicative ((f))) => instance functorFromApplicative :: Functor (f)
9287
93− instance Num Prim.Number
88+ instance numNumber :: Num (Prim.Number)
9489
95− instance Ord Prim.Number
90+ instance ordNumber :: Ord (Prim.Number)
9691
97− instance Prelude.Show Prim.Number
92+ instance readBoolean :: Read (Prim.Boolean)
9893
99− instance Read Prim.String
94+ instance readNumber :: Read (Prim.Number)
10095
101− instance Read Prim.Boolean
96+ instance readString :: Read (Prim.String)
10297
103− instance Read Prim.Number
98+ instance showBoolean :: Show (Prim.Boolean)
10499
105− instance Show Prim.String
100+ instance showNumber :: Show (Prim.Number)
106101
107− instance Show Prim.Boolean
102+ instance showString :: Show (Prim.String)
108103
109104
110105### Values
@@ -127,8 +122,6 @@
127122
128123 flip :: forall c. forall b. forall a. (a -> b -> c) -> b -> a -> c
129124
130− liftRef :: forall b. forall a. (a -> a -> b) -> Ref a -> Ref a -> b
131−
132125 numAdd :: Prim.Number -> Prim.Number -> Prim.Number
133126
134127 numAnd :: Prim.Number -> Prim.Number -> Prim.Number
@@ -163,13 +156,9 @@
163156
164157 numZshr :: Prim.Number -> Prim.Number -> Prim.Number
165158
166− readNumber :: Prim.String -> Prim.Number
167−
168− refEq :: forall a. Ref a -> Ref a -> Prim.Boolean
169−
170− refIneq :: forall a. Ref a -> Ref a -> Prim.Boolean
159+ readNumberImpl :: Prim.String -> Prim.Number
171160
172− showNumber :: Prim.Number -> Prim.String
161+ showNumberImpl :: Prim.Number -> Prim.String
173162
174163 unsafeRefEq :: forall a. a -> a -> Prim.Boolean
175164
@@ -190,9 +179,9 @@
190179
191180### Type Class Instances
192181
193− instance Monoid Prim.String
182+ instance monoidArray :: Monoid ([a])
194183
195− instance Monoid [a]
184+ instance monoidString :: Monoid (Prim.String)
196185
197186
198187### Values
@@ -229,6 +218,8 @@
229218
230219 when :: forall m. (Monad (m)) => Prim.Boolean -> m { } -> m { }
231220
221+ zipWithM :: forall c. forall b. forall a. forall m. (Monad (m)) => (a -> b -> m c) -> [a] -> [b] -> m [c]
222+
232223
233224## Module Data.Maybe
234225
@@ -244,13 +235,13 @@
244235
245236### Type Class Instances
246237
247− instance Prelude.Applicative Maybe
238+ instance applicativeMaybe :: Applicative (Maybe)
248239
249− instance Prelude.Functor Maybe
240+ instance functorMaybe :: Functor (Maybe)
250241
251− instance Prelude.Monad Maybe
242+ instance monadMaybe :: Monad (Maybe)
252243
253− (Show (a)) => instance Prelude.Show Maybe a
244+ (Show ((a))) => instance showMaybe :: Show (Maybe a)
254245
255246
256247### Values
@@ -274,13 +265,13 @@
274265
275266### Type Class Instances
276267
277− instance Prelude.Applicative Either e
268+ instance applicativeEither :: Applicative (Either e)
278269
279− instance Prelude.Functor Either a
270+ instance functorEither :: Functor (Either a)
280271
281− instance Prelude.Monad Either e
272+ instance monadEither :: Monad (Either e)
282273
283− (Show (a),Show (b)) => instance Prelude.Show Either a b
274+ (Show ((a)),Show ((b))) => instance showEither :: Show (Either a b)
284275
285276
286277### Values
@@ -298,13 +289,13 @@
298289
299290### Type Class Instances
300291
301− instance Prelude.Alternative Prim.Array
292+ instance alternativeArray :: Alternative (Prim.Array)
302293
303− instance Prelude.Functor Prim.Array
294+ instance functorArray :: Functor (Prim.Array)
304295
305− instance Prelude.Monad Prim.Array
296+ instance monadArray :: Monad (Prim.Array)
306297
307− (Prelude.Show (a)) => instance Prelude.Show [a]
298+ (Show ((a))) => instance showArray :: Show ([a])
308299
309300
310301### Values
@@ -319,11 +310,15 @@
319310
320311 concatMap :: forall b. forall a. [a] -> (a -> [b]) -> [b]
321312
313+ deleteAt :: forall a. Prim.Number -> Prim.Number -> [a] -> [a]
314+
315+ drop :: forall a. Prim.Number -> [a] -> [a]
316+
322317 filter :: forall a. (a -> Prim.Boolean) -> [a] -> [a]
323318
324319 find :: forall a. (a -> Prim.Boolean) -> [a] -> Maybe a
325320
326− foldl :: forall b. forall a. (a -> b -> b) -> b -> [a] -> b
321+ foldl :: forall b. forall a. (b -> a -> b) -> b -> [a] -> b
327322
328323 foldr :: forall b. forall a. (a -> b -> a) -> a -> [b] -> a
329324
@@ -331,6 +326,8 @@
331326
332327 indexOf :: forall a. [a] -> a -> Prim.Number
333328
329+ insertAt :: forall a. Prim.Number -> a -> [a] -> [a]
330+
334331 isEmpty :: forall a. [a] -> Prim.Boolean
335332
336333 joinS :: [Prim.String] -> Prim.String
@@ -357,13 +354,40 @@
357354
358355 sort :: forall a. [a] -> [a]
359356
360− splice :: forall a. Prim.Number -> Prim.Number -> [a] -> [a] -> [a]
361−
362357 tail :: forall a. [a] -> Maybe [a]
363358
359+ take :: forall a. Prim.Number -> [a] -> [a]
360+
361+ updateAt :: forall a. Prim.Number -> a -> [a] -> [a]
362+
364363 zipWith :: forall c. forall b. forall a. (a -> b -> c) -> [a] -> [b] -> [c]
365364
366365
366+## Module Data.Eq
367+
368+### Types
369+
370+ data Ref a where
371+ Ref :: a -> Ref a
372+
373+
374+### Type Classes
375+
376+
377+### Type Class Instances
378+
379+ instance eqRef :: Eq (Ref a)
380+
381+
382+### Values
383+
384+ liftRef :: forall b. forall a. (a -> a -> b) -> Ref a -> Ref a -> b
385+
386+ refEq :: forall a. Ref a -> Ref a -> Prim.Boolean
387+
388+ refIneq :: forall a. Ref a -> Ref a -> Prim.Boolean
389+
390+
367391## Module Data.Array.Unsafe
368392
369393### Types
@@ -395,7 +419,7 @@
395419
396420### Type Class Instances
397421
398− (Prelude.Show (a),Prelude.Show (b)) => instance Prelude.Show Tuple a b
422+ (Show ((a)),Show ((b))) => instance showTuple :: Show (Tuple a b)
399423
400424
401425### Values
@@ -593,7 +617,7 @@
593617
594618### Type Class Instances
595619
596− instance Prelude.Monad Eff e
620+ instance monadEff :: Monad (Eff e)
597621
598622
599623### Values
@@ -613,6 +637,22 @@
613637 whileE :: forall a. forall e. Eff e Prim.Boolean -> Eff e a -> Eff e { }
614638
615639
640+## Module Control.Monad.Eff.Unsafe
641+
642+### Types
643+
644+
645+### Type Classes
646+
647+
648+### Type Class Instances
649+
650+
651+### Values
652+
653+ unsafeInterleaveEff :: forall a. forall eff2. forall eff1. Eff eff1 a -> Eff eff2 a
654+
655+
616656## Module Random
617657
618658### Types
@@ -694,7 +734,7 @@
694734
695735### Values
696736
697− print :: forall r. forall a. (Prelude.Show (a)) => a -> Eff (trace :: Trace | r) { }
737+ print :: forall r. forall a. (Show (a)) => a -> Eff (trace :: Trace | r) { }
698738
699739 trace :: forall r. Prim.String -> Eff (trace :: Trace | r) { }
700740