From fda508967620a864a9dc834a76d71ae26bd440fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Basile=20Cl=C3=A9ment?= Date: Thu, 29 Aug 2024 11:13:39 +0200 Subject: [PATCH] Clarify doc --- src/lib/reasoners/domains_intf.ml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/lib/reasoners/domains_intf.ml b/src/lib/reasoners/domains_intf.ml index a60b42414..f6954545d 100644 --- a/src/lib/reasoners/domains_intf.ml +++ b/src/lib/reasoners/domains_intf.ml @@ -140,9 +140,11 @@ module type EphemeralDomainMap = sig (** [set_domain e d] sets the domain of entry [e] to [d]. This overwrites any pre-existing domain associated with [e]. - {b Note}: if you need to tighten an existing domain, this must be done - explicitely by accessing the current domain through [domain] before - calling [set_domain]. See {!MakEntryNotation}. *) + {b Note}: the caller is responsible for ensuring that the domain is + a subset of the possible domains for the entry (e.g. due to type + constraints). The recommended way to do so is by first intersecting + with the existing [domain]. See also the {!EntryNotation} functor + which does this for you. *) end val entry : t -> key -> Entry.t