Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean Up Documentation #180

Merged
merged 2 commits into from
Apr 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
### Enhancements
* Added support for python 3.12. @mavaylon1 [#172](https://github.com/hdmf-dev/hdmf-zarr/pull/172)

### Docs
* Removed `linkable` from the documentation to keep in line with `hdmf-schema-language`. @mavaylon1 [#180](https://github.com/hdmf-dev/hdmf-zarr/pull/180)

## 0.6.0 (February 21, 2024)

### Enhancements
Expand Down
7 changes: 2 additions & 5 deletions docs/source/storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ Groups
datasets Zarr datasets within the Zarr group
attributes Zarr attributes on the Zarr group
links Stored as JSON formatted attributes on the Zarr Group
linkable Not mapped; Stored in schema only
quantity Not mapped; Number of appearances of the group
neurodata_type Attribute ``neurodata_type`` on the Zarr Group
namespace ID Attribute ``namespace`` on the Zarr Group
Expand Down Expand Up @@ -89,7 +88,6 @@ Datasets
shape Shape of the Zarr dataset if the shape is fixed, otherwise shape defines the maxshape
dims Not mapped
attributes Zarr attributes on the Zarr dataset
linkable Not mapped; Stored in schema only
quantity Not mapped; Number of appearances of the dataset
neurodata_type Attribute ``neurodata_type`` on the Zarr dataset
namespace ID Attribute ``namespace`` on the Zarr dataset
Expand Down Expand Up @@ -404,7 +402,6 @@ operations when retrieving certain metadata in read mode.

.. note::

When updating a file, the consolidated metadata will also need to be updated via
`zarr.consolidate_metadata(path)` to ensure the consolidated metadata is consistent
When updating a file, the consolidated metadata will also need to be updated via
`zarr.consolidate_metadata(path)` to ensure the consolidated metadata is consistent
with the file.

Loading