Skip to content

Commit 578e470

Browse files
Update documentation (#613)
Co-authored-by: daniil-quix <[email protected]>
1 parent 8623080 commit 578e470

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

docs/api-reference/quixstreams.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10201,8 +10201,7 @@ class FileSource(Source)
1020110201
Ingest a set of local files into kafka by iterating through the provided folder and
1020210202
processing all nested files within it.
1020310203

10204-
Expects folder and file structures as generated by the related Quix Streams File
10205-
Sink Connector:
10204+
Expects folder and file structures as generated by the related FileSink connector:
1020610205

1020710206
my_topics/
1020810207
├── topic_a/
@@ -10252,7 +10251,7 @@ def __init__(filepath: Union[str, Path],
1025210251
shutdown_timeout: float = 10)
1025310252
```
1025410253

10255-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/community/file/file.py#L60)
10254+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/community/file/file.py#L59)
1025610255

1025710256
**Arguments**:
1025810257

@@ -10277,7 +10276,7 @@ to gracefully shutdown
1027710276
def default_topic() -> Topic
1027810277
```
1027910278

10280-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/community/file/file.py#L107)
10279+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/community/file/file.py#L106)
1028110280

1028210281
Uses the file structure to generate the desired partition count for the
1028310282

docs/api-reference/sources.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -638,8 +638,7 @@ class FileSource(Source)
638638
Ingest a set of local files into kafka by iterating through the provided folder and
639639
processing all nested files within it.
640640

641-
Expects folder and file structures as generated by the related Quix Streams File
642-
Sink Connector:
641+
Expects folder and file structures as generated by the related FileSink connector:
643642

644643
my_topics/
645644
├── topic_a/
@@ -691,7 +690,7 @@ def __init__(filepath: Union[str, Path],
691690
shutdown_timeout: float = 10)
692691
```
693692

694-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/community/file/file.py#L60)
693+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/community/file/file.py#L59)
695694

696695

697696
<br>
@@ -720,7 +719,7 @@ to gracefully shutdown
720719
def default_topic() -> Topic
721720
```
722721

723-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/community/file/file.py#L107)
722+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/community/file/file.py#L106)
724723

725724
Uses the file structure to generate the desired partition count for the
726725

0 commit comments

Comments
 (0)