Skip to content

Commit

Permalink
docstrings WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
Lomand committed Nov 11, 2023
1 parent 288aa13 commit 0a03c5a
Show file tree
Hide file tree
Showing 20 changed files with 3,917 additions and 4,034 deletions.
30 changes: 15 additions & 15 deletions src/Tablecloth.res
Original file line number Diff line number Diff line change
@@ -1,46 +1,46 @@
@ocaml.doc(" Functions for working with boolean ([true] or [false]) values. ")
/** Functions for working with boolean ([true] or [false]) values. */
module Bool = TableclothBool

@ocaml.doc(" Functions for working with single characters. ")
/** Functions for working with single characters. */
module Char = TableclothChar

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

@ocaml.doc(" Fixed precision integers ")
/** Fixed precision integers */
module Int = TableclothInt

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

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

@ocaml.doc(" A fixed lenfth collection of values ")
/** A fixed lenfth collection of values */
module Array = TableclothArray

@ocaml.doc(" Arbitrary length, singly linked lists ")
/** Arbitrary length, singly linked lists */
module List = TableclothList

@ocaml.doc(" Functions for working with optional values. ")
/** Functions for working with optional values. */
module Option = TableclothOption

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

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

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

module Comparator = TableclothComparator

@ocaml.doc(" A collection of unique values ")
/** A collection of unique values */
module Set = TableclothSet

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

@ocaml.doc(" Functions for working with functions. ")
/** Functions for working with functions. */
module Fun = TableclothFun
Loading

0 comments on commit 0a03c5a

Please sign in to comment.