From 5720e1c47c2e3ffc9e7f6c60ff050735494cc8cc Mon Sep 17 00:00:00 2001 From: Ryan Morey Date: Mon, 22 Jan 2024 15:56:57 -0500 Subject: [PATCH] docs: fix URL references for neuroglancer --- tensorstore/driver/neuroglancer_precomputed/index.rst | 2 +- tensorstore/driver/neuroglancer_precomputed/metadata.h | 2 +- tensorstore/driver/neuroglancer_precomputed/schema.yml | 8 ++++---- tensorstore/kvstore/neuroglancer_uint64_sharded/index.rst | 2 +- .../neuroglancer_uint64_sharded/uint64_sharded_decoder.h | 2 +- .../neuroglancer_uint64_sharded/uint64_sharded_encoder.h | 6 +++--- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/tensorstore/driver/neuroglancer_precomputed/index.rst b/tensorstore/driver/neuroglancer_precomputed/index.rst index 8d37ed123..078e87ee6 100644 --- a/tensorstore/driver/neuroglancer_precomputed/index.rst +++ b/tensorstore/driver/neuroglancer_precomputed/index.rst @@ -3,7 +3,7 @@ ``neuroglancer_precomputed`` Driver =================================== -The ``neuroglancer_precomputed`` driver provides access to `Neuroglancer Precomputed format `_ volumes backed by any supported :ref:`key_value_store`. It supports reading, writing, and creating new volumes. +The ``neuroglancer_precomputed`` driver provides access to `Neuroglancer Precomputed format `_ volumes backed by any supported :ref:`key_value_store`. It supports reading, writing, and creating new volumes. Multiscale volumes are supported, but each scale must be opened individually. diff --git a/tensorstore/driver/neuroglancer_precomputed/metadata.h b/tensorstore/driver/neuroglancer_precomputed/metadata.h index 9ef3c6924..ec72d3027 100644 --- a/tensorstore/driver/neuroglancer_precomputed/metadata.h +++ b/tensorstore/driver/neuroglancer_precomputed/metadata.h @@ -19,7 +19,7 @@ /// Metadata handling for the Neuroglancer precomputed format. /// /// Refer to the specification here: -/// https://github.com/google/neuroglancer/tree/master/src/neuroglancer/datasource/precomputed +/// https://github.com/google/neuroglancer/tree/master/src/datasource/precomputed #include #include diff --git a/tensorstore/driver/neuroglancer_precomputed/schema.yml b/tensorstore/driver/neuroglancer_precomputed/schema.yml index 2d170ff48..9b4858aa8 100644 --- a/tensorstore/driver/neuroglancer_precomputed/schema.yml +++ b/tensorstore/driver/neuroglancer_precomputed/schema.yml @@ -24,7 +24,7 @@ allOf: description: |- Specifies the scale-independent metadata of a new volume exactly as in the `info file - `_, + `_, except that not all members are required. Required when creating a new multiscale volume. When opening an existing volume or creating a new scale within an existing multiscale volume, specifies constraints on the @@ -58,7 +58,7 @@ allOf: title: Per-scale metadata. description: |- Specifies the per-scale metadata of a new volume as in the `info file - `_, + `_, except that not all members are required, and the `.chunk_size` member for specifying a single chunk size takes the place of the :literal:`chunk_sizes` member in the :file:`info` file. Required when creating a @@ -157,9 +157,9 @@ allOf: - type: 'null' description: |- Specifies to use the `unsharded - `_ + `_ (indicated by ``null``) or `sharded - `_ + `_ format. When creating a new scale, if not specified, the unsharded format is used. definitions: diff --git a/tensorstore/kvstore/neuroglancer_uint64_sharded/index.rst b/tensorstore/kvstore/neuroglancer_uint64_sharded/index.rst index 3fddb8dcb..e3bd24572 100644 --- a/tensorstore/kvstore/neuroglancer_uint64_sharded/index.rst +++ b/tensorstore/kvstore/neuroglancer_uint64_sharded/index.rst @@ -5,7 +5,7 @@ The ``neuroglancer_uint64_sharded`` driver implements support for the `Neuroglancer Precomputed sharded format -`_ +`_ on top of a base key-value store. Within the key-value store interface, which uses strings as keys, the uint64 diff --git a/tensorstore/kvstore/neuroglancer_uint64_sharded/uint64_sharded_decoder.h b/tensorstore/kvstore/neuroglancer_uint64_sharded/uint64_sharded_decoder.h index b0f1b87aa..01b8c4b65 100644 --- a/tensorstore/kvstore/neuroglancer_uint64_sharded/uint64_sharded_decoder.h +++ b/tensorstore/kvstore/neuroglancer_uint64_sharded/uint64_sharded_decoder.h @@ -19,7 +19,7 @@ /// Support for decoding the neuroglancer_uint64_sharded_v1 format. /// /// See description of format here: -/// https://github.com/google/neuroglancer/tree/master/src/neuroglancer/datasource/precomputed#sharded-format +/// https://github.com/google/neuroglancer/tree/master/src/datasource/precomputed#sharded-format #include #include diff --git a/tensorstore/kvstore/neuroglancer_uint64_sharded/uint64_sharded_encoder.h b/tensorstore/kvstore/neuroglancer_uint64_sharded/uint64_sharded_encoder.h index ee05a0d5f..5002a59a1 100644 --- a/tensorstore/kvstore/neuroglancer_uint64_sharded/uint64_sharded_encoder.h +++ b/tensorstore/kvstore/neuroglancer_uint64_sharded/uint64_sharded_encoder.h @@ -22,7 +22,7 @@ /// arbitrary keys with only 3 reads. /// /// See description of format here: -/// https://github.com/google/neuroglancer/tree/master/src/neuroglancer/datasource/precomputed#sharded-format +/// https://github.com/google/neuroglancer/tree/master/src/datasource/precomputed#sharded-format #include @@ -42,14 +42,14 @@ namespace neuroglancer_uint64_sharded { /// Encodes a minishard index. /// /// The format is described here: -/// https://github.com/google/neuroglancer/tree/master/src/neuroglancer/datasource/precomputed#minishard-index-format +/// https://github.com/google/neuroglancer/tree/master/src/datasource/precomputed#minishard-index-format absl::Cord EncodeMinishardIndex( span minishard_index); /// Encodes a shard index. /// /// The format is described here: -/// https://github.com/google/neuroglancer/tree/master/src/neuroglancer/datasource/precomputed#shardindex-index-file-format +/// https://github.com/google/neuroglancer/tree/master/src/datasource/precomputed#shardindex-index-file-format absl::Cord EncodeShardIndex(span shard_index); /// Class that may be used to sequentially encode a single shard.