Merge pull request #164 from anmonteiro/patch-1

Fix the `Angstrom.Buffered.state_to_option` docstring
inhabitedtype · Mar 3, 2019 · 48b901c · 48b901c
2 parents 3a3e245 + 6e482ee
commit 48b901c
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lib/angstrom.mli b/lib/angstrom.mli
@@ -535,12 +535,12 @@ module Buffered : sig
       copied into the state's buffer for later use by the caller. *)
 
   val state_to_option : 'a state -> 'a option
-  (** [state_to_option state] returns [Some (bs, v)] if the parser is in the
+  (** [state_to_option state] returns [Some v] if the parser is in the
       [Done (bs, v)] state and [None] otherwise. This function has no effect on
       the current state of the parser. *)
 
   val state_to_result : 'a state -> ('a, string) result
-  (** [state_to_result state] returns [Ok v] if the parser is in the [Done v]
+  (** [state_to_result state] returns [Ok v] if the parser is in the [Done (bs, v)]
       state and [Error msg] if it is in the [Fail] or [Partial] state.
 
       This function has no effect on the current state of the parser. *)