Skip to content

Commit

Permalink
Merge pull request ocaml-batteries-team#245 from agarwal/v2-tuple
Browse files Browse the repository at this point in the history 
V2 tuple docs
  • Loading branch information
@thelema
thelema committed Feb 8, 2012
2 parents 61e5cbe + 7ac1644 commit 0af5ccf
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions src/batTuple.mli
View file
Expand Up @@ -19,11 +19,7 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*) *)


(** Tuples. (** Tuples. Modules are provided for tuples with 2, 3, 4, and 5
NOTE: API changes are expected in a future release.
Modules are provided for tuples with 2, 3, 4, and 5
elements. Each provides the following categories of functions. elements. Each provides the following categories of functions.
Projection. Functions [first], [second], [third], [fourth], and [fifth] Projection. Functions [first], [second], [third], [fourth], and [fifth]
Expand All @@ -47,8 +43,8 @@
same type. same type.
Currying. Every tuple has a [curry] and [uncurry] function, which Currying. Every tuple has a [curry] and [uncurry] function, which
allow converting between functions that take [n] arguments to ones allows converting between functions that take [n] arguments to
that take a single [n]-tuple argument. ones that take a single [n]-tuple argument.
Enumeration. Every [n]-tuple can be converted to an enum with [n] Enumeration. Every [n]-tuple can be converted to an enum with [n]
elements using its [enum] function, and can be constructed from an elements using its [enum] function, and can be constructed from an
Expand Down

0 comments on commit 0af5ccf

Please sign in to comment.