From 664b629d8617e2f6cafeb8013b8edfc80742b804 Mon Sep 17 00:00:00 2001 From: Ilan Gold Date: Thu, 26 Sep 2024 15:54:22 +0200 Subject: [PATCH] (chore): clean up release notes (#1698) * (chore): clean up release notes * (fix): remove `module` --- docs/release-notes/0.11.0rc1.md | 8 ++++---- docs/release-notes/0.11.0rc2.md | 7 ++++++- docs/release-notes/1682.feat.md | 2 -- 3 files changed, 10 insertions(+), 7 deletions(-) delete mode 100644 docs/release-notes/1682.feat.md diff --git a/docs/release-notes/0.11.0rc1.md b/docs/release-notes/0.11.0rc1.md index edbb807dd..f9efdc388 100644 --- a/docs/release-notes/0.11.0rc1.md +++ b/docs/release-notes/0.11.0rc1.md @@ -1,21 +1,21 @@ (v0.11.0rc1)= ### 0.11.0rc1 {small}`2024-09-04` -### Breaking changes +#### Breaking changes - Removed deprecated modules `anndata.core` and `anndata.readwrite` {user}`ivirshup` ({pr}`1197`) - No longer export `sparse_dataset` from `anndata.experimental`, instead exporting {func}`anndata.io.sparse_dataset` {user}`ilan-gold` ({pr}`1642`) - Move `RWAble` and `InMemoryElem` out of `experimental`, renaming `RWAble` to {type}`~anndata.typing.AxisStorable` and `InMemoryElem` to {type}`~anndata.typing.RWAble` {user}`ilan-gold` ({pr}`1643`) -### Development Process +#### Development Process - create new `cupy` installation options for cuda 11 & 12 called `cu11` and `cu12` {user}`Intron7` ({pr}`1596`) -### Documentation +#### Documentation - Correct {attr}`anndata.AnnData.X` type to include {class}`~anndata.abc.CSRDataset` and {class}`~anndata.abc.CSCDataset` as possible types and being deprecation process for non-csr/csc {class}`scipy.sparse.spmatrix` types in {attr}`anndata.AnnData.X` {user}`ilan-gold` ({pr}`1616`) -### Features +#### Features - `scipy.sparse.csr_array` and `scipy.sparse.csc_array` are now supported when constructing `AnnData` objects {user}`ilan-gold` {user}`isaac-virshup` ({pr}`1028`) - Allow `axis` parameter of e.g. :func:`anndata.concat` to accept `'obs'` and `'var'` {user}`flying-sheep` ({pr}`1244`) diff --git a/docs/release-notes/0.11.0rc2.md b/docs/release-notes/0.11.0rc2.md index 68466a848..ecb5049d2 100644 --- a/docs/release-notes/0.11.0rc2.md +++ b/docs/release-notes/0.11.0rc2.md @@ -1,7 +1,12 @@ (v0.11.0rc2)= ### 0.11.0rc2 {small}`2024-09-24` -### Development Process +#### Development Process - Add extra `dask` dependency for installation i.e., `pip install anndata[dask]` {user}`ilan-gold` ({pr}`1677`) - Remove `shall_` from variable names in `settings` {user}`ilan-gold` ({pr}`1685`) + +#### Breaking changes + +- A new `anndata.io` module contains all `read_*` and `write_*` functions, and all imports of such functions should go through this module. +Old ways of importing these functions i.e., `from anndata import read_csv` or `from anndata._io.specs import read_elem` will still work, but are now considered deprecated and give a warning on import with the exception of {func}`anndata.io.read_zarr` and {func}`anndata.io.read_h5ad`, which will remain at the top-level `anndata` without warning. `user`{ilan-gold} ({pr}`1682`) diff --git a/docs/release-notes/1682.feat.md b/docs/release-notes/1682.feat.md deleted file mode 100644 index 926f9ffb4..000000000 --- a/docs/release-notes/1682.feat.md +++ /dev/null @@ -1,2 +0,0 @@ -A new {mod}`anndata.io` module contains all `read_*` and `write_*` functions, and all imports of such functions should go through this module. -Old ways of importing these functions i.e., `from anndata import read_csv` or `from anndata._io.specs import read_elem` will still work, but are now considered deprecated and give a warning on import with the exception of {func}`anndata.io.read_zarr` and {func}`anndata.io.read_h5ad`, which will remain at the top-level `anndata` without warning. `user`{ilan-gold}