Skip to content

Commit

Permalink
Add disclaimer to Pp
Browse files Browse the repository at this point in the history
Signed-off-by: Jeremie Dimino <[email protected]>
  • Loading branch information
jeremiedimino committed Nov 10, 2020
1 parent a920738 commit 5cfc5f6
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/pp.mli
Original file line number Diff line number Diff line change
Expand Up @@ -175,5 +175,11 @@ val to_fmt_with_tags :

(** {1 Injection} *)

(** Inject a classic formatter in a document *)
(** Inject a classic formatter in a document.
Disclaimer: this function is to meant to help using [Pp] in
existing code that already use the [Format] module without having
to port everything to [Pp]. It is not meant as the normal way to
create [Pp.t] values.
*)
val of_fmt : (Format.formatter -> 'a -> unit) -> 'a -> _ t

0 comments on commit 5cfc5f6

Please sign in to comment.