Skip to content

Commit 9f705fc

Browse files
authored
Fix typos in docs (#289)
1 parent c0dd684 commit 9f705fc

File tree

4 files changed

+12
-13
lines changed

4 files changed

+12
-13
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Read [the documentation](https://manzt.github.io/zarrita.js) to learn more.
5959

6060
zarrita's API is almost entirely tree-shakeable, meaning developers are able to
6161
pick and choose the features necessary for an application. This design choice
62-
differs from existing implemenations of Zarr in JavaScript, and allows zarrita
62+
differs from existing implementations of Zarr in JavaScript, and allows zarrita
6363
to be both minimal and more feature-complete if necessary.
6464

6565
```mermaid

docs/packages/storage.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ creating their custom stores as needed.
4444

4545
## Implementations
4646

47-
The **@zarrita/storage** package provides some useful storage implementions;
47+
The **@zarrita/storage** package provides some useful storage implementations;
4848
some are tailored for browsers, while others are designed for various JS
4949
runtimes like Node.js and Deno.
5050

@@ -93,9 +93,8 @@ These options override the defaults for the store, except headers are merged
9393

9494
### FileSystemStore <Badge type="tip" text="Readable" /> <Badge type="tip" text="Writable" />
9595

96-
Designed for JavaScript runtimes with file system access, the The
97-
**FileSystemStore** is designed for JavaScript runtimes with file system access
98-
(i.e., server-side JavaScript). It is build atop the Node.js
96+
The **FileSystemStore** is designed for JavaScript runtimes with file system access
97+
(i.e., server-side JavaScript). It is built atop the Node.js
9998
[`fs`](https://nodejs.org/api/fs.html) module and is compatible with
10099
environments like Node.js, Bun, and Deno.
101100

docs/packages/zarrita.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ hierarchy and load individual array chunks.
55

66
## Zarr hierarchy
77

8-
A Zarr dataset is structured as a hierarchy, composed up of **arrays** and
8+
A Zarr dataset is structured as a hierarchy, composed of **arrays** and
99
**groups**. This hierarchy can be visualized in a manner similar to a file
1010
system:
1111

@@ -96,7 +96,7 @@ let arr = await zarr.open.v2(root.resolve("foo/bar"), { kind: "array" });
9696

9797
### Access a chunk
9898

99-
To load individual **array** chunks on demand base on their key, use the
99+
To load individual **array** chunks on demand based on their key, use the
100100
`Array.getChunk` method. This feature is useful in applications where you want
101101
to load chunks lazily (i.e. a tiled image viewer).
102102

@@ -123,7 +123,7 @@ console.log(chunk);
123123
- `stride` – the number of elements needed to advance one value along each
124124
dimension
125125

126-
This is the minimal representation of the chunk data is often suitable for many
126+
This minimal representation of the chunk data is often suitable for many
127127
applications. However, for further processing or manipulations of the chunk
128128
data, you can integrate with [`scijs/ndarray`](https://github.com/scijs/ndarray)
129129
to convert it into an `ndarray` object.
@@ -214,7 +214,7 @@ to static type systems. **zarrita** leverages TypeScript's advanced typing
214214
capabilities to extract and communicate Zarr `data_type` metadata across its
215215
APIs.
216216

217-
In essense, you (moreover your editor) is always informed about the data types
217+
In essence, you (moreover your editor) is always informed about the data types
218218
at hand when working with Zarr via **zarrita**. TypeScript assists in
219219
covering edge cases, but (importantly) steps back once you've demonstrated data
220220
correctness.
@@ -281,7 +281,7 @@ if (
281281
}
282282
```
283283

284-
Assert data types like this repeatedly can be cumbersome and repetative.
284+
Assert data types like this repeatedly can be cumbersome and repetitive.
285285

286286
Instead, wouldn't it be convenient if you could verify the data type once, and
287287
then TypeScript would automatically understand the expected data type for all
@@ -291,11 +291,11 @@ subsequent `getChunk` calls?
291291

292292
```javascript
293293
if (!arr.is("int64") || !arr.is("uint64")) {
294-
thow Error("data type not supported!");
294+
throw Error("data type not supported!");
295295
}
296296
const chunk = await arr.getChunk([0, 0]);
297297
// ^ Chunk<"int64" | "uint64">
298-
getBigIntValue(cunk.data, 0); // 0n
298+
getBigIntValue(chunk.data, 0); // 0n
299299
```
300300

301301
With this method, you've informed TypeScript about the possible data types for

docs/what-is-zarrita.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ const region = await get(arr, [null, null]);
4646

4747
### [@zarrita/storage](/packages/storage)
4848

49-
- A collection of useful of storage backends for Zarr.
49+
- A collection of useful storage backends for Zarr.
5050
- Implement your own `Readable` and (optionally `Writable`) stores.
5151

5252

0 commit comments

Comments
 (0)