Skip to content

Commit 3bec8f5

Browse files
committed
Updated headers of slice source types
1 parent e57527d commit 3bec8f5

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/guide.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -519,24 +519,25 @@ If the `slice_source` setting is _not_ specified, the slice items passed as `sli
519519
argument to the [`zappend`](api.md) Python function can be one of the types described
520520
in the following subsections.
521521

522-
#### `str` and `zappend.api.FileObj`
522+
#### Types `str` and `FileObj`
523523

524524
A slice object of type `str` is interpreted as local file path or URI, in the case
525525
the path has a protocol prefix, such as `s3://`.
526526

527-
An alternative to providing the slice dataset as path or URI is using the `FileObj`
528-
class, which combines a URI with dedicated filesystem storage options.
527+
An alternative to providing the slice dataset as path or URI is using the
528+
`zappend.api.FileObj` class, which combines a URI with dedicated filesystem
529+
storage options.
529530

530531
```python
531532
from zappend.api import FileObj
532533

533534
slice_obj = FileObj(slice_uri, storage_options=dict(...))
534535
```
535536

536-
#### `xarray.Dataset`
537+
#### Type `Dataset`
537538

538-
In-memory slice objects can be passed as [xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html) objects.
539-
Such objects may originate from opening datasets from some storage
539+
In-memory slice objects can be passed as [`xarray.Dataset`](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html)
540+
objects. Such objects may originate from opening datasets from some storage
540541

541542
```python
542543
import xarray as xr
@@ -568,7 +569,7 @@ If the flag is set, in-memory slices will be persisted to a temporary Zarr befor
568569
appending them to the target dataset. It may prevent expensive re-computation of chunks
569570
at the cost of additional i/o. It therefore defaults to `false`.
570571

571-
#### `zappend.api.SliceSource`
572+
#### Type `SliceSource`
572573

573574
Often you want to perform some custom cleanup after a slice has been processed and
574575
appended to the target dataset. In this case you can write your own
@@ -578,7 +579,7 @@ methods.
578579
Slice source instances are supposed to be created by _slice factories_, see
579580
subsection below.
580581

581-
#### `zappend.api.SliceFactory`
582+
#### Type `SliceFactory`
582583

583584
A slice factory is a 1-argument function that receives a processing context of type
584585
`zappend.api.Context` and yields a slice dataset object of one of the types

0 commit comments

Comments
 (0)