config: more comments; make Config.t private

forcing users to use `Config.make` to build a new config means we can
add fields without breaking existing code.
This commit is contained in:
Simon Cruanes 2022-07-06 12:06:12 -04:00
parent 59c1d7254c
commit 85b6e91615
No known key found for this signature in database
GPG key ID: EBFFF6F283F3A2B4

View file

@ -1,4 +1,4 @@
type t = {
type t = private {
debug: bool;
url: string;
(** Url of the endpoint. Default is "http://localhost:4318",
@ -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 ->