diff options
| author | ElHassan Wanas <ewanas@tutanota.com> | 2019-10-13 14:19:32 +0300 |
|---|---|---|
| committer | El-Hassan Wanas <elhassan.wanas@gmail.com> | 2019-10-15 12:44:44 +0300 |
| commit | e271e8fa4d8bf3f42c15883674dd318edccee289 (patch) | |
| tree | f995dd4a1c76b14d85dc6ac987421cbcd12cbcd4 /stdlib/listLabels.mli | |
| parent | fd8094e99ae78a94931dbedddae5025930f61e26 (diff) | |
| download | ocaml-e271e8fa4d8bf3f42c15883674dd318edccee289.tar.gz | |
Updated documentation for StringLabels, ArrayLabels, ListLabels and BytesLabels to show StdLabels usage
Diffstat (limited to 'stdlib/listLabels.mli')
| -rw-r--r-- | stdlib/listLabels.mli | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/stdlib/listLabels.mli b/stdlib/listLabels.mli index 64fbff8723..3a6366b3bd 100644 --- a/stdlib/listLabels.mli +++ b/stdlib/listLabels.mli @@ -27,7 +27,16 @@ type 'a t = 'a list = [] | (::) of 'a * 'a list (**) The above considerations can usually be ignored if your lists are not longer than about 10000 elements. -*) + + This module is intended to be used through {!StdLabels} which would replace + {!Array}, {!Bytes}, {!List} and {!String} with their labeled counterparts. + + As an example usage: + {[ + open StdLabels + + let seq len = List.init ~f:(function i -> i) ~len + ]} *) val length : 'a list -> int (** Return the length (number of elements) of the given list. *) |