Skip to content

Commit acd5b58

Browse files
authored
Merge pull request #10393 from Maria-12648430/improve_sets_subtract_docs
Improve documentation of `sets`/`ordsets`/`gb_sets:subtract/2`
2 parents 8e8f742 + 9dbb208 commit acd5b58

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

lib/stdlib/src/gb_sets.erl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1267,7 +1267,8 @@ is_disjoint_1(_, nil) ->
12671267
%% traverse the whole element list of the left operand.
12681268

12691269
-doc """
1270-
Returns the elements of `Set1` that are not elements in `Set2`.
1270+
Returns a new set containing the elements of `Set1`
1271+
that are not elements in `Set2`.
12711272

12721273
## Examples
12731274

lib/stdlib/src/ordsets.erl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,8 @@ is_disjoint(_, []) ->
422422
true.
423423

424424
-doc """
425-
Returns the elements of `Ordset1` that are not elements in `Ordset2`.
425+
Returns a new ordered set containing the elements of `Ordset1`
426+
that are not elements in `Ordset2`.
426427

427428
## Examples
428429

lib/stdlib/src/sets.erl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -697,7 +697,8 @@ is_disjoint_1(Set, Iter) ->
697697
end.
698698

699699
-doc """
700-
Returns the elements of `Set1` that are not elements in `Set2`.
700+
Returns a new set containing the elements of `Set1`
701+
that are not elements in `Set2`.
701702

702703
## Examples
703704

0 commit comments

Comments
 (0)