Skip to content

Commit

Permalink
config: more comments; make Config.t private
Browse files Browse the repository at this point in the history
forcing users to use `Config.make` to build a new config means we can
add fields without breaking existing code.
  • Loading branch information
c-cube committed Jul 6, 2022
1 parent 59c1d72 commit 85b6e91
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/client/config.mli
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
type t = {
type t = private {
debug: bool;
url: string;
(** Url of the endpoint. Default is "http://localhost:4318",
Expand Down Expand Up @@ -35,6 +35,10 @@ type t = {
sure it makes progress, and regularly send events to the collector.
This option is ignored if [thread=false]. *)
}
(** Configuration.
To build one, use {!make} below. This might be extended with more
fields in the future. *)

val make :
?debug:bool ->
Expand Down

0 comments on commit 85b6e91

Please sign in to comment.