8000 DOC: misc minor updates/reordering to changelog · larray-project/larray@8511149 · GitHub
[go: up one dir, main page]

Skip to content

Commit 8511149

Browse files
committed
DOC: misc minor updates/reordering to changelog
1 parent 8558966 commit 8511149

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

doc/source/changes/version_0_34.rst.inc

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,14 @@
44
Syntax changes
55
^^^^^^^^^^^^^^
66

7-
* deprecated :py:obj:`Session.add()`. Please use :py:obj:`Session.update()` instead (closes :issue:`999`).
7+
* made :py:obj:`Array.append()` work for the cases previously covered by ``Array.extend()`` (when the appended value
8+
already has the axis being extended) and deprecated ``Array.extend()`` (closes :issue:`887`).
89

9-
* deprecated passing individual session elements as non-keyword arguments to :py:obj:`Session()`.
10-
This means that, for example, ``Session(axis1, axis2, array1=array1)`` should be rewritten as
11-
``Session(axis1name=axis1, axis2name=axis2, array1=array1)`` instead. Closes :issue:`1024`.
10+
* renamed ``Array.sort_axes()`` to :py:obj:`Array.sort_labels()` (closes :issue:`861`).
1211

1312
* renamed :py:obj:`Array.percentile()` and :py:obj:`Array.percentile_by()` `interpolation` argument
1413
to `method` to follow numpy and thus support additional "interpolation" methods.
1514

16-
* renamed ``Array.sort_axes()`` to :py:obj:`Array.sort_labels()` (closes :issue:`861`).
17-
18-
* made :py:obj:`Array.append()` work for the cases previously covered by ``Array.extend()`` (when the appended value
19-
already has the axis being extended) and deprecated ``Array.extend()`` (closes :issue:`887`).
20-
2115
* deprecated the ability to target a label in an aggregated array using the group that created it.
2216
The aggregated array label should be used instead. This is a seldom used feature which is complex
2317
to keep working and has a significant performance cost in some cases, even when the feature is not used
@@ -46,6 +40,12 @@ Syntax changes
4640
>>> agg_arr['a0_a2']
4741
2
4842

43+
* deprecated passing individual session elements as non-keyword arguments to :py:obj:`Session()`.
44+
This means that, for example, ``Session(axis1, axis2, array1=array1)`` should be rewritten as
45+
``Session(axis1name=axis1, axis2name=axis2, array1=array1)`` instead. Closes :issue:`1024`.
46+
47+
* deprecated :py:obj:`Session.add()`. Please use :py:obj:`Session.update()` instead (closes :issue:`999`).
48+
4949

5050
Backward incompatible changes
5151
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -59,6 +59,8 @@ Backward incompatible changes
5959
New features
6060
^^^^^^^^^^^^
6161

62+
* added support for Python 3.10.
63+
6264
* implemented :py:obj:`Array.value_counts()`, which computes the number of occurrences of each unique value in an array.
6365

6466
* added :py:obj:`Session.nbytes` and added :py:obj:`Session.memory_used` attributes.
@@ -69,13 +71,14 @@ New features
6971
Miscellaneous improvements
7072
^^^^^^^^^^^^^^^^^^^^^^^^^^
7173

72-
* made all I/O functions/methods/constructors to accept either a string or a pathlib.Path object
74+
* made all I/O functions/methods/constructors accept pathlib.Path objects in addition to strings
7375
for all arguments representing a path (closes :issue:`896`).
7476

7577
* added type hints for all remaining functions and methods which improves autocompletion in editors (such as PyCharm).
7678
Closes :issue:`864`.
7779

78-
* made several error message more useful when trying to get an invalid subset of an array (closes :issue:`875`).
80+
* made several error messages more useful when trying to get an invalid subset of an array (closes :issue:`875`).
81+
7982
- when a key is not valid on any axis, the error message includes the array axes
8083
- when a key is not valid for the axis specified by the user, the error message includes that axis labels
8184
- when a label is ambiguous (valid on several axes), the error message includes the axes labels in addition to the
@@ -86,7 +89,7 @@ Miscellaneous improvements
8689
* made :py:obj:`ipfp()` faster (the smaller the array, the larger the improvement)
8790
For example, for small arrays it is several times faster than before, for 1000x1000 arrays it is about 30% faster.
8891

89-
* made operations between two Arrays with the same axes much faster.
92+
* made arithmetic operations between two Arrays with the same axes much faster.
9093

9194
* made Array[] faster in the usual/simple cases.
9295

0 commit comments

Comments
 (0)
0