From f8f04e771db87c58d12631212eca52d44d6eaeca Mon Sep 17 00:00:00 2001 From: Gabriel Scherer Date: Fri, 26 Oct 2018 15:30:16 +0200 Subject: [PATCH] clarify Set.diff documentation (#2119) fixes [MPR#7868](https://caml.inria.fr/mantis/view.php?id=7868) --- .mailmap | 1 + Changes | 3 +++ stdlib/set.mli | 3 ++- 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.mailmap b/.mailmap index cf030ef36..691db8ce9 100644 --- a/.mailmap +++ b/.mailmap @@ -117,6 +117,7 @@ Miod Vallat Christoph Spiel Joris Giovannangeli Wilfred Hughes +John Skaller # These contributors prefer to be referred to pseudonymously whitequark diff --git a/Changes b/Changes index 0519e4187..22a7b58e9 100644 --- a/Changes +++ b/Changes @@ -130,6 +130,9 @@ Working version (Laurent Thévenoux, review by Alain Frisch, Jacques-Henri Jourdan, Xavier Leroy) +- GPR#2119: clarify the documentation of Set.diff + (Gabriel Scherer, suggestion by John Skaller) + ### Other libraries: - GPR#1061: Add ?follow parameter to Unix.link. This allows hardlinking diff --git a/stdlib/set.mli b/stdlib/set.mli index 4e8e94bf7..1de4a9b5e 100644 --- a/stdlib/set.mli +++ b/stdlib/set.mli @@ -103,7 +103,8 @@ module type S = @since 4.08.0 *) val diff: t -> t -> t - (** Set difference. *) + (** Set difference: [diff s1 s2] contains the elements of [s1] + that are not in [s2]. *) val compare: t -> t -> int (** Total ordering between sets. Can be used as the ordering function