Skip to content

Commit

Permalink
Cleanup stores.md and associated root docs
Browse files Browse the repository at this point in the history
  • Loading branch information
LDeakin committed Oct 20, 2024
1 parent 5665838 commit 750d183
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
9 changes: 6 additions & 3 deletions zarrs/doc/status/stores.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,26 @@
| [OpendalStore] | | ✓* | ✓* | ✓* | ✓ | | [zarrs_opendal] |
| [AsyncOpendalStore] | | ✓* | ✓* | ✓* | | ✓ | [zarrs_opendal] |
| [AsyncObjectStore] | | ✓* | ✓* | ✓* | | ✓ | [zarrs_object_store] |
| [AsyncIcechunkStore] | | ✓* | ✓* | ✓* | | ✓ | [zarrs_icechunk] |
| [HTTPStore] | | ✓ | | | ✓ | | [zarrs_http] |
| [AsyncToSyncStorageAdapter] | | &check; | &check; | &check; | &check; | &check; | [zarrs_storage]<sup>†</sup> |
| [UsageLogStorageAdapter] | | &check; | &check; | &check; | &check; | &check; | [zarrs_storage]<sup>†</sup> |
| [PerformanceMetricsStorageAdapter] | | &check; | &check; | &check; | &check; | &check; | [zarrs_storage]<sup>†</sup> |
| [ZipStorageAdapter] | | &check; | | &check; | &check; | | [zarrs_zip] |

<sup>† Re-exported in the `zarrs::storage` module</sup>
<sup>† Re-exported in the `zarrs::storage` module.</sup>
<br>
<sup>‡ Re-exported as the `zarrs::filesystem` module</sup>
<sup>‡ Re-exported as the `zarrs::filesystem` module.</sup>
<br>
<sup>\* Support depends on the [`opendal`](https://docs.rs/opendal/latest/opendal/) [`BlockingOperator`](https://docs.rs/opendal/latest/opendal/struct.BlockingOperator.html)/[`Operator`](https://docs.rs/opendal/latest/opendal/struct.Operator.html) or [`object_store`](https://docs.rs/object_store/latest/object_store/) [store](https://docs.rs/object_store/latest/object_store/index.html#modules).</sup>
<sup>\* Support depends on the underlying store.</sup>

[0001]: https://zarr.dev/zeps/accepted/ZEP0001.html

[zarrs_storage]: https://docs.rs/zarrs_storage/latest/zarrs_storage/
[zarrs_filesystem]: https://docs.rs/zarrs_filesystem/latest/zarrs_filesystem/
[zarrs_object_store]: https://docs.rs/zarrs_object_store/latest/zarrs_object_store/
[zarrs_opendal]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/
[zarrs_icechunk]: https://docs.rs/zarrs_icechunk/latest/zarrs_icechunk/
[zarrs_http]: https://docs.rs/zarrs_http/latest/zarrs_http/
[zarrs_zip]: https://docs.rs/zarrs_zip/latest/zarrs_zip/

Expand All @@ -31,6 +33,7 @@
[OpendalStore]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/struct.OpendalStore.html
[AsyncOpendalStore]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/struct.AsyncOpendalStore.html
[AsyncObjectStore]: https://docs.rs/zarrs_object_store/latest/zarrs_object_store/struct.AsyncObjectStore.html
[AsyncIcechunkStore]: https://docs.rs/zarrs_icechunk/latest/zarrs_icechunk/struct.AsyncIcechunkStore.html
[HTTPStore]: https://docs.rs/zarrs_http/latest/zarrs_http/struct.HTTPStore.html

[AsyncToSyncStorageAdapter]: crate::storage::storage_adapter::async_to_sync::AsyncToSyncStorageAdapter
Expand Down
16 changes: 13 additions & 3 deletions zarrs/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,21 @@
//!
#![doc = include_str!("../doc/status/stores.md")]
//!
//! A huge range of storage backends are supported via the [`opendal`](https://docs.rs/opendal/latest/opendal/) and [`object_store`](https://docs.rs/opendal/latest/object_store/) crates.
//! The documentation for the [zarrs_opendal] and [zarrs_object_store] crates includes version compatibility matrices with `zarrs` and the associated storage backends.
//! A huge range of storage backends are supported via the [`opendal`] and [`object_store`] crates.
//! The documentation for the [`zarrs_opendal`] and [`zarrs_object_store`] crates includes version compatibility matrices with `zarrs` and the associated storage backends.
//! These backends provide more feature complete HTTP stores than [zarrs_http].
//!
//! Asynchronous stores can be used in a synchronous context with the [`AsyncToSyncStorageAdapter`](crate::storage::storage_adapter::async_to_sync::AsyncToSyncStorageAdapter).
//! [`zarrs_icechunk`] implements the [Icechunk](https://icechunk.io/overview/) transactional storage engine, a storage specification for Zarr.
//! It supports [`object_store`] stores.
//!
//! [`opendal`]: https://docs.rs/opendal/latest/opendal/
//! [`object_store`]: https://docs.rs/object_store/latest/object_store/
//! [`object_store`]: https://docs.rs/object_store/latest/object_store/
//! [`zarrs_icechunk`]: https://docs.rs/zarrs_icechunk/latest/zarrs_icechunk/
//! [`zarrs_object_store`]: https://docs.rs/zarrs_object_store/latest/zarrs_object_store/
//! [`zarrs_opendal`]: https://docs.rs/zarrs_opendal/latest/zarrs_opendal/
//!
//! The [`AsyncToSyncStorageAdapter`](crate::storage::storage_adapter::async_to_sync::AsyncToSyncStorageAdapter) enables some async stores to be used in a sync context.
//!
//! ## Examples
#![cfg_attr(feature = "ndarray", doc = "```rust")]
Expand Down

0 comments on commit 750d183

Please sign in to comment.