File 0685-Remove-description-of-structure-of-opaque-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0685-Remove-description-of-structure-of-opaque-type-gb_tr.patch of Package erlang

From ce117d73133a371d394bda9c112d4e40b978b3d1 Mon Sep 17 00:00:00 2001
From: Brujo Benavides <fernando.benavides@adroll.com>
Date: Mon, 1 Apr 2019 08:47:52 -0300
Subject: [PATCH] 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.
---
 lib/stdlib/doc/src/gb_trees.xml | 7 ++-----
 1 file 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>
-
- <c>Tree</c> is composed of nodes of the form <c>{Key, Value, Smaller,
- Bigger}</c> and the "empty tree" node <c>nil</c>.
+ Trees and iterators are built using opaque data structures that should
+ not be pattern-matched from outside this module.
 
 There is no attempt to balance trees after deletions. As
 deletions do not increase the height of a tree, this should be OK.
-- 
2.16.4

Places

File 0685-Remove-description-of-structure-of-opaque-type-gb_tr.patch of Package erlang

Places