diff options
| author | Brujo Benavides <[email protected]> | 2019-04-01 08:47:52 -0300 |
|---|---|---|
| committer | Hans Bolinder <[email protected]> | 2019-05-02 14:43:46 +0200 |
| commit | ce117d73133a371d394bda9c112d4e40b978b3d1 (patch) | |
| tree | fe928843ce1cf4fcbbc98c0c95aac46aeb35ace5 | |
| parent | e77fef6f36e2fbe79b14759642e9b5d498b55ec0 (diff) | |
| download | otp-ce117d73133a371d394bda9c112d4e40b978b3d1.tar.gz otp-ce117d73133a371d394bda9c112d4e40b978b3d1.tar.bz2 otp-ce117d73133a371d394bda9c112d4e40b978b3d1.zip | |
Remove description of structure of opaque type `gb_trees:tree/2`.
Since it's an opaque type, its internal structure shouldn't be
part of the docs. Otherwise it leads misguided devs to the
assumption that they can pattern-match on it, when they shouldn't.
| -rw-r--r-- | lib/stdlib/doc/src/gb_trees.xml | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/lib/stdlib/doc/src/gb_trees.xml b/lib/stdlib/doc/src/gb_trees.xml index 570c9c7cb6..08aa1865e8 100644 --- a/lib/stdlib/doc/src/gb_trees.xml +++ b/lib/stdlib/doc/src/gb_trees.xml @@ -42,11 +42,8 @@ <section> <title>Data Structure</title> - <code type="none"> -{Size, Tree}</code> - - <p><c>Tree</c> is composed of nodes of the form <c>{Key, Value, Smaller, - Bigger}</c> and the "empty tree" node <c>nil</c>.</p> + <p>Trees and iterators are built using opaque data structures that should + not be pattern-matched from outside this module.</p> <p>There is no attempt to balance trees after deletions. As deletions do not increase the height of a tree, this should be OK.</p> |