Skip to content

Commit 44fc609

Browse files
Update documentation (#499)
Co-authored-by: daniil-quix <133032822+daniil-quix@users.noreply.github.com>
1 parent 5421e73 commit 44fc609

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/api-reference/quixstreams.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9115,7 +9115,7 @@ def __init__(path: str,
91159115

91169116
A base CSV source that reads data from a single CSV file.
91179117

9118-
Best used with :class:`quixstreams.sinks.csv.CSVSink`.
9118+
Best used with `quixstreams.sinks.csv.CSVSink`.
91199119

91209120
Required columns: key, value
91219121
Optional columns: timestamp
@@ -9179,7 +9179,7 @@ def raise_for_error() -> None
91799179

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

9182-
Raise a :class:`quixstreams.sources.manager.SourceException`
9182+
Raise a `quixstreams.sources.manager.SourceException`
91839183
if the child process was terminated with an exception.
91849184

91859185
<a id="quixstreams.sources.manager.SourceProcess.stop"></a>
@@ -9544,11 +9544,11 @@ def serialize(key: Optional[object] = None,
95449544

95459545
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/base.py#L233)
95469546

9547-
Serialize data to bytes using the producer topic serializers and return a :class:`quixstreams.models.messages.KafkaMessage` .
9547+
Serialize data to bytes using the producer topic serializers and return a `quixstreams.models.messages.KafkaMessage`.
95489548

95499549
**Returns**:
95509550

9551-
:class:`quixstreams.models.messages.KafkaMessage`
9551+
`quixstreams.models.messages.KafkaMessage`
95529552

95539553
<a id="quixstreams.sources.base.Source.produce"></a>
95549554

@@ -9607,7 +9607,7 @@ The default topic will not be used if the topic has already been provided to the
96079607

96089608
**Returns**:
96099609

9610-
`:class:`quixstreams.models.topics.Topic`
9610+
`quixstreams.models.topics.Topic`
96119611

96129612
<a id="quixstreams.rowconsumer"></a>
96139613

docs/api-reference/sources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -298,13 +298,13 @@ def serialize(key: Optional[object] = None,
298298

299299
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/sources/base.py#L233)
300300

301-
Serialize data to bytes using the producer topic serializers and return a :class:`quixstreams.models.messages.KafkaMessage` .
301+
Serialize data to bytes using the producer topic serializers and return a `quixstreams.models.messages.KafkaMessage`.
302302

303303

304304
<br>
305305
***Returns:***
306306

307-
:class:`quixstreams.models.messages.KafkaMessage`
307+
`quixstreams.models.messages.KafkaMessage`
308308

309309
<a id="quixstreams.sources.base.Source.produce"></a>
310310

@@ -373,5 +373,5 @@ The default topic will not be used if the topic has already been provided to the
373373
<br>
374374
***Returns:***
375375

376-
`:class:`quixstreams.models.topics.Topic`
376+
`quixstreams.models.topics.Topic`
377377

0 commit comments

Comments
 (0)