Skip to content

Commit

Permalink
Update documentation (#648)
Browse files Browse the repository at this point in the history
Co-authored-by: daniil-quix <[email protected]>
  • Loading branch information
github-actions[bot] and daniil-quix authored Nov 27, 2024
1 parent aaa0486 commit 0ac2ff1
Show file tree
Hide file tree
Showing 4 changed files with 552 additions and 10 deletions.
10 changes: 5 additions & 5 deletions docs/api-reference/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@ Default: the source default
def run(dataframe: Optional[StreamingDataFrame] = None)
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L679)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L685)

Start processing data from Kafka using provided `StreamingDataFrame`

Expand Down Expand Up @@ -530,7 +530,7 @@ app.run()
def setup_topics()
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L802)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L808)

Validate and create the topics

Expand All @@ -542,7 +542,7 @@ Validate and create the topics
class ApplicationConfig(BaseSettings)
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L978)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L984)

Immutable object holding the application configuration

Expand All @@ -565,7 +565,7 @@ def settings_customise_sources(
) -> Tuple[PydanticBaseSettingsSource, ...]
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1013)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1019)

Included to ignore reading/setting values from the environment

Expand All @@ -579,7 +579,7 @@ Included to ignore reading/setting values from the environment
def copy(**kwargs) -> Self
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1026)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1032)

Update the application config and return a copy

Loading

0 comments on commit 0ac2ff1

Please sign in to comment.