document tree future changes

Author: alimanfoo

zarr/convenience.py

@@ -403,6 +403,11 @@ def tree(grp, expand=False, level=None):
     --------
     zarr.hierarchy.Group.tree
 
+    Notes
+    -----
+    Please note that the behaviour of this function is still evolving and the
+    default output and/or parameters may change in future versions.
+
     """
 
     return TreeViewer(grp, expand=expand, level=level)

zarr/hierarchy.py

@@ -603,6 +603,11 @@ def tree(self, expand=False, level=None):
          └── quux
              └── baz (100,) float64
 
+        Notes
+        -----
+        Please note that the behaviour of this function is still evolving and the
+        default output and/or parameters may change in future versions.
+
         """
 
         return TreeViewer(self, expand=expand, level=level)