From 8791dff88dd1dd255454c7ffc9cec5d6b7c5127f Mon Sep 17 00:00:00 2001 From: Oliver Ruebel Date: Thu, 7 Nov 2024 16:19:28 -0800 Subject: [PATCH] Update docstring --- CHANGELOG.md | 2 +- src/hdmf_zarr/backend.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 845a2509..675563b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ ### Enhancements * Added support for Pathlib paths. @mavaylon1 [#212](https://github.com/hdmf-dev/hdmf-zarr/pull/212) * Updated packages used for testing and readthedocs configuration. @mavaylon1, @rly [#214](https://github.com/hdmf-dev/hdmf-zarr/pull/214) -* Add `force_overwite` parameter for `ZarrIO.__init__` to allow overwriting an existing file with a Zarr file, not just a directory. @oruebel [#229](https://github.com/hdmf-dev/hdmf-zarr/pull/229) +* Add `force_overwite` parameter for `ZarrIO.__init__` to allow overwriting an existing file or directory. @oruebel [#229](https://github.com/hdmf-dev/hdmf-zarr/pull/229) ## 0.9.0 (September 16, 2024) ### Enhancements diff --git a/src/hdmf_zarr/backend.py b/src/hdmf_zarr/backend.py index 6aa95a29..dbc26d4e 100644 --- a/src/hdmf_zarr/backend.py +++ b/src/hdmf_zarr/backend.py @@ -106,8 +106,8 @@ def can_read(path): 'default': None}, {'name': 'force_overwrite', 'type': bool, - 'doc': "force overwriting existing object when in 'w' mode even" - " if the existing object is a file (e.g., and HDF5 file)", + 'doc': "force overwriting existing object when in 'w' mode. The existing file or directory" + " will be deleted when before opening (even if the object is not Zarr, e.g,. an HDF5 file)", 'default': False} ) def __init__(self, **kwargs):