Skip to content

Commit b221441

Browse files
committed
note tree() as experimental
1 parent 46e6c61 commit b221441

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

zarr/convenience.py

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -405,8 +405,9 @@ def tree(grp, expand=False, level=None):
405405
406406
Notes
407407
-----
408-
Please note that the behaviour of this function is still evolving and the
409-
default output and/or parameters may change in future versions.
408+
Please note that this is an experimental feature. The behaviour of this
409+
function is still evolving and the default output and/or parameters may change
410+
in future versions.
410411
411412
"""
412413

@@ -552,6 +553,12 @@ def copy_store(source, dest, source_path='', dest_path='', excludes=None,
552553
array([ 0, 1, 2, ..., 97, 98, 99])
553554
>>> store2.close() # zip stores need to be closed
554555
556+
Notes
557+
-----
558+
Please note that this is an experimental feature. The behaviour of this
559+
function is still evolving and the default behaviour and/or parameters may change
560+
in future versions.
561+
555562
"""
556563

557564
# normalize paths
@@ -756,6 +763,12 @@ def copy(source, dest, name=None, shallow=False, without_attrs=False, log=None,
756763
dry run: 3 copied, 1 skipped
757764
(3, 1, 0)
758765
766+
Notes
767+
-----
768+
Please note that this is an experimental feature. The behaviour of this
769+
function is still evolving and the default behaviour and/or parameters may change
770+
in future versions.
771+
759772
"""
760773

761774
# value checks
@@ -1026,6 +1039,12 @@ def copy_all(source, dest, shallow=False, without_attrs=False, log=None,
10261039
└── spam (100,) int64
10271040
>>> source.close()
10281041
1042+
Notes
1043+
-----
1044+
Please note that this is an experimental feature. The behaviour of this
1045+
function is still evolving and the default behaviour and/or parameters may change
1046+
in future versions.
1047+
10291048
"""
10301049

10311050
# value checks

zarr/hierarchy.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -605,8 +605,9 @@ def tree(self, expand=False, level=None):
605605
606606
Notes
607607
-----
608-
Please note that the behaviour of this function is still evolving and the
609-
default output and/or parameters may change in future versions.
608+
Please note that this is an experimental feature. The behaviour of this
609+
function is still evolving and the default output and/or parameters may change
610+
in future versions.
610611
611612
"""
612613

0 commit comments

Comments
 (0)