Skip to content

Commit 0e1cacb

Browse files
committed
Added reason
1 parent c61f71e commit 0e1cacb

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

docs/guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ zappend(os.listdir("inputs"),
7474
dry_run=True)
7575
```
7676

77-
This remainder of this guide explains the how to use the various `zappend`
77+
The remainder of this guide explains the how to use the various `zappend`
7878
[configuration](config.md) settings.
7979

8080
!!! note

zappend/api.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,15 @@ def zappend(
6262
Args:
6363
slices: An iterable that yields slice items.
6464
config: Processor configuration.
65-
May be a file path or URI, a `dict`, `None`, or a sequence of
65+
Can be a file path or URI, a `dict`, `None`, or a sequence of
6666
the aforementioned. If a sequence is used, subsequent
6767
configurations are incremental to the previous ones.
6868
kwargs: Additional configuration parameters.
6969
Can be used to pass or override configuration values in *config*.
70+
7071
Returns:
71-
The number of slices processed.
72+
The number of slices processed. The value can be useful if
73+
the number of items in `slices` is unknown.
7274
"""
7375
processor = Processor(config, **kwargs)
7476
return processor.process_slices(slices)

0 commit comments

Comments
 (0)