New and better wording for scanf_format functions.

git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@7298 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02

1 files changed, 8 insertions, 6 deletions

diff --git a/stdlib/scanf.mli b/stdlib/scanf.mli
index 4f830e67c..adf700d1a 100644
--- a/stdlib/scanf.mli
+++ b/stdlib/scanf.mli
@@ -258,12 +258,14 @@ val kscanf :
 val bscanf_format :
   Scanning.scanbuf -> ('a, 'b, 'c, 'd) format4 ->
     (('a, 'b, 'c, 'd) format4 -> 'e) -> 'e;;
-(** [bscanf_format ib fmt f] reads a [format] argument to the format
-  specified by the second argument. The [format] argument read in
-  buffer [ib] must have the same type as [fmt]. *)
+
+(** [bscanf_format ib fmt f] reads a format string token in buffer [ib],
+  according to the format string [fmt], and applies the function [f] to the
+  resulting format string value.
+  Raises [Scan_failure] if the format string value read has not the same type
+  as [fmt]. *)
 
 val sscanf_format :
   string -> ('a, 'b, 'c, 'd) format4 -> ('a, 'b, 'c, 'd) format4;;
-(** [sscanf_format ib fmt f] reads a [format] argument to the format
-  specified by the second argument and returns it. The [format]
-  argument read in string [s] must have the same type as [fmt]. *)
+(** Same as {!Scanf.bscanf_format}, but converts the given string to a format
+  string. *)