Skip to content

Commit deb6fc1

Browse files
committed
docstrings WIP
1 parent 9e2b910 commit deb6fc1

20 files changed

+3917
-4034
lines changed

src/Tablecloth.res

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
1-
@ocaml.doc(" Functions for working with boolean ([true] or [false]) values. ")
1+
/** Functions for working with boolean ([true] or [false]) values. */
22
module Bool = TableclothBool
33

4-
@ocaml.doc(" Functions for working with single characters. ")
4+
/** Functions for working with single characters. */
55
module Char = TableclothChar
66

7-
@ocaml.doc(" Functions for working with [\"strings\"] ")
7+
/** Functions for working with ["strings"] */
88
module String = TableclothString
99

10-
@ocaml.doc(" Fixed precision integers ")
10+
/** Fixed precision integers */
1111
module Int = TableclothInt
1212

13-
@ocaml.doc(" Functions for working with floating point numbers. ")
13+
/** Functions for working with floating point numbers. */
1414
module Float = TableclothFloat
1515

16-
@ocaml.doc(" Interfaces for use with container types like {!Array} or {!List} ")
16+
/** Interfaces for use with container types like {!Array} or {!List} */
1717
module Container = TableclothContainer
1818

19-
@ocaml.doc(" A fixed lenfth collection of values ")
19+
/** A fixed lenfth collection of values */
2020
module Array = TableclothArray
2121

22-
@ocaml.doc(" Arbitrary length, singly linked lists ")
22+
/** Arbitrary length, singly linked lists */
2323
module List = TableclothList
2424

25-
@ocaml.doc(" Functions for working with optional values. ")
25+
/** Functions for working with optional values. */
2626
module Option = TableclothOption
2727

28-
@ocaml.doc(" Functions for working with computations which may fail. ")
28+
/** Functions for working with computations which may fail. */
2929
module Result = TableclothResult
3030

31-
@ocaml.doc(" Functions for manipulating tuples of length two ")
31+
/** Functions for manipulating tuples of length two */
3232
module Tuple2 = TableclothTuple2
3333

34-
@ocaml.doc(" Functions for manipulating tuples of length three ")
34+
/** Functions for manipulating tuples of length three */
3535
module Tuple3 = TableclothTuple3
3636

3737
module Comparator = TableclothComparator
3838

39-
@ocaml.doc(" A collection of unique values ")
39+
/** A collection of unique values */
4040
module Set = TableclothSet
4141

42-
@ocaml.doc(" A collection of key-value pairs ")
42+
/** A collection of key-value pairs */
4343
module Map = TableclothMap
4444

45-
@ocaml.doc(" Functions for working with functions. ")
45+
/** Functions for working with functions. */
4646
module Fun = TableclothFun

0 commit comments

Comments
 (0)