Skip to content

Commit 311158c

Browse files
github-actions[bot]quentin-quix
and
quentin-quix
authored
Update documentation (#497)
Co-authored-by: quentin-quix <171557156+quentin-quix@users.noreply.github.com>
1 parent 33449a3 commit 311158c

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/api-reference/application.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,7 @@ app.run(dataframe=df)
628628
class ApplicationConfig(BaseSettings)
629629
```
630630

631-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1049)
631+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1056)
632632

633633
Immutable object holding the application configuration
634634

@@ -651,7 +651,7 @@ def settings_customise_sources(
651651
) -> Tuple[PydanticBaseSettingsSource, ...]
652652
```
653653

654-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1083)
654+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1090)
655655

656656
Included to ignore reading/setting values from the environment
657657

@@ -665,7 +665,7 @@ Included to ignore reading/setting values from the environment
665665
def copy(**kwargs) -> Self
666666
```
667667

668-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1096)
668+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1103)
669669

670670
Update the application config and return a copy
671671

docs/api-reference/quixstreams.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9043,7 +9043,7 @@ app.run(dataframe=df)
90439043
class ApplicationConfig(BaseSettings)
90449044
```
90459045

9046-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1049)
9046+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1056)
90479047

90489048
Immutable object holding the application configuration
90499049

@@ -9064,7 +9064,7 @@ def settings_customise_sources(
90649064
) -> Tuple[PydanticBaseSettingsSource, ...]
90659065
```
90669066

9067-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1083)
9067+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1090)
90689068

90699069
Included to ignore reading/setting values from the environment
90709070

@@ -9076,7 +9076,7 @@ Included to ignore reading/setting values from the environment
90769076
def copy(**kwargs) -> Self
90779077
```
90789078

9079-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1096)
9079+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1103)
90809080

90819081
Update the application config and return a copy
90829082

@@ -9160,7 +9160,7 @@ Some methods are designed to be used from the parent process, and others from th
91609160
def run() -> None
91619161
```
91629162

9163-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L48)
9163+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L53)
91649164

91659165
An entrypoint of the child process.
91669166

@@ -9177,7 +9177,7 @@ Responsible for:
91779177
def raise_for_error() -> None
91789178
```
91799179

9180-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L108)
9180+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L115)
91819181

91829182
Raise a :class:`quixstreams.sources.manager.SourceException`
91839183
if the child process was terminated with an exception.
@@ -9190,7 +9190,7 @@ if the child process was terminated with an exception.
91909190
def stop()
91919191
```
91929192

9193-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L129)
9193+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L136)
91949194

91959195
Handle shutdown of the source and its subprocess.
91969196

@@ -9206,7 +9206,7 @@ is still alive, it will kill it with a SIGKILL.
92069206
class SourceManager()
92079207
```
92089208

9209-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L152)
9209+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L159)
92109210

92119211
Class managing the sources registered with the app
92129212

@@ -9220,7 +9220,7 @@ Sources run in their separate process pay attention about cross-process communic
92209220
def register(source: BaseSource)
92219221
```
92229222

9223-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L162)
9223+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L169)
92249224

92259225
Register a new source in the manager.
92269226

@@ -9234,7 +9234,7 @@ Each source need to already be configured, can't reuse a topic and must be uniqu
92349234
def raise_for_error() -> None
92359235
```
92369236

9237-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L201)
9237+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L209)
92389238

92399239
Raise an exception if any process has stopped with an exception
92409240

@@ -9246,7 +9246,7 @@ Raise an exception if any process has stopped with an exception
92469246
def is_alive() -> bool
92479247
```
92489248

9249-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L208)
9249+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L216)
92509250

92519251
Check if any process is alive
92529252

@@ -9262,7 +9262,7 @@ True if at least one process is alive
92629262
class SourceException(Exception)
92639263
```
92649264

9265-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L231)
9265+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/manager.py#L238)
92669266

92679267
Raised in the parent process when a source finish with an exception
92689268

0 commit comments

Comments
 (0)