From b93b7444230ebc358f8b0d64798e65f50a249e5a Mon Sep 17 00:00:00 2001
From: Michal Muskala
Date: Wed, 16 Nov 2016 11:54:26 +0100
Subject: Document the ordering used in ordsets and orddicts
Right now the exact order of elements is not specified, yet many
programs rely on the ordering being the obvious one - erlang term order.
It is only beneficial to make this an explicit part of the
documentation.
---
lib/stdlib/doc/src/ordsets.xml | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
(limited to 'lib/stdlib/doc/src/ordsets.xml')
diff --git a/lib/stdlib/doc/src/ordsets.xml b/lib/stdlib/doc/src/ordsets.xml
index 148281fcf7..7b590932e4 100644
--- a/lib/stdlib/doc/src/ordsets.xml
+++ b/lib/stdlib/doc/src/ordsets.xml
@@ -39,7 +39,8 @@
Sets are collections of elements with no duplicate elements.
An ordset is a representation of a set, where an ordered
list is used to store the elements of the set. An ordered list
- is more efficient than an unordered list.
+ is more efficient than an unordered list. Elements are ordered
+ according to the Erlang term order.
This module provides the same interface as the
sets(3) module
--
cgit v1.2.3