Skip to content

Commit 5429692

Browse files
committed
improve relnote
1 parent fa751d7 commit 5429692

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

docs/release-notes/2436.chore.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
Flip default for {attr}`anndata.settings.disallow_forward_slash_in_h5ad` {user}`flying-sheep`
1+
Flip default for {attr}`anndata.settings.disallow_forward_slash_in_h5ad`.
2+
Document writing to `k="/"` in {func}`~anndata.io.write_elem` and check `k` more strictly {user}`flying-sheep`

src/anndata/_io/specs/registry.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -521,8 +521,9 @@ def write_elem(
521521
store
522522
The group to write to.
523523
k
524-
The key to write to in the group. Note that absolute paths will be written
525-
from the root.
524+
The key to write into the group.
525+
If the group is the root, set `k` to `"/"` to write directly into it.
526+
Passing an absolute path referring to a direct child of the group is also allowed.
526527
elem
527528
The element to write. Typically an in-memory object, e.g. an AnnData, pandas
528529
dataframe, scipy sparse matrix, etc.

0 commit comments

Comments
 (0)