Skip to content

Commit

Permalink
Update documentation (#497)
Browse files Browse the repository at this point in the history
Co-authored-by: quentin-quix <[email protected]>
  • Loading branch information
github-actions[bot] and quentin-quix authored Sep 11, 2024
1 parent 33449a3 commit 311158c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions docs/api-reference/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ app.run(dataframe=df)
class ApplicationConfig(BaseSettings)
```

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

Immutable object holding the application configuration

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

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

Included to ignore reading/setting values from the environment

Expand All @@ -665,7 +665,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#L1096)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1103)

Update the application config and return a copy

22 changes: 11 additions & 11 deletions docs/api-reference/quixstreams.md
Original file line number Diff line number Diff line change
Expand Up @@ -9043,7 +9043,7 @@ app.run(dataframe=df)
class ApplicationConfig(BaseSettings)
```

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

Immutable object holding the application configuration

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

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

Included to ignore reading/setting values from the environment

Expand All @@ -9076,7 +9076,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#L1096)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1103)

Update the application config and return a copy

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

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

An entrypoint of the child process.

Expand All @@ -9177,7 +9177,7 @@ Responsible for:
def raise_for_error() -> None
```

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

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

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

Handle shutdown of the source and its subprocess.

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

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

Class managing the sources registered with the app

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

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

Register a new source in the manager.

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

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

Raise an exception if any process has stopped with an exception

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

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

Check if any process is alive

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

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

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

Expand Down

0 comments on commit 311158c

Please sign in to comment.