Skip to content

Commit

Permalink
Merge pull request #145 from dinosaure/documentation
Browse files Browse the repository at this point in the history
Better documentation about take_bigstring*
  • Loading branch information
seliopou authored May 18, 2018
2 parents 165e993 + 8198ccf commit c914dbc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions lib/angstrom.mli
Original file line number Diff line number Diff line change
Expand Up @@ -128,25 +128,25 @@ val take_till : (char -> bool) -> string t

val take_bigstring : int -> bigstring t
(** [take_bigstring n] accepts exactly [n] characters of input and returns them
as a bigstring. *)
as a newly allocated bigstring. *)

val take_bigstring_while : (char -> bool) -> bigstring t
(** [take_bigstring_while f] accepts input as long as [f] returns [true] and
returns the accepted characters as a bigstring.
returns the accepted characters as a newly allocated bigstring.
This parser does not fail. If [f] returns [false] on the first character,
it will return the empty bigstring. *)

val take_bigstring_while1 : (char -> bool) -> bigstring t
(** [take_bigstring_while f] accepts input as long as [f] returns [true] and
returns the accepted characters as a bigstring.
returns the accepted characters as a newly allocated bigstring.
This parser requires that [f] return [true] for at least one character of
input, and will fail otherwise. *)

val take_bigstring_till : (char -> bool) -> bigstring t
(** [take_bigstring_till f] accepts input as long as [f] returns [false] and
returns the accepted characters as a bigstring.
returns the accepted characters as a newly allocated bigstring.
This parser does not fail. If [f] returns [true] on the first character, it
will return the empty bigstring. *)
Expand Down

0 comments on commit c914dbc

Please sign in to comment.