Skip to content

Commit f4e3b88

Browse files
github-actions[bot]quentin-quix
andauthored
Update documentation (#717)
Co-authored-by: quentin-quix <[email protected]>
1 parent 262b80c commit f4e3b88

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/api-reference/quixstreams.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6230,7 +6230,7 @@ def topic(name: str,
62306230
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
62316231
```
62326232

6233-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L254)
6233+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L255)
62346234

62356235
A convenience method for generating a `Topic`. Will use default config options
62366236

@@ -6259,7 +6259,7 @@ Topic object with creation configs
62596259
def register(topic: Topic) -> Topic
62606260
```
62616261

6262-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L300)
6262+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L301)
62636263

62646264
Register an already generated :class:`quixstreams.models.topics.Topic` to the topic manager.
62656265

@@ -6283,7 +6283,7 @@ def repartition_topic(operation: str,
62836283
timeout: Optional[float] = None) -> Topic
62846284
```
62856285

6286-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L318)
6286+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L319)
62876287

62886288
Create an internal repartition topic.
62896289

@@ -6312,7 +6312,7 @@ def changelog_topic(topic_name: Optional[str],
63126312
timeout: Optional[float] = None) -> Topic
63136313
```
63146314

6315-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L358)
6315+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L359)
63166316

63176317
Performs all the logic necessary to generate a changelog topic based on an
63186318

@@ -6354,7 +6354,7 @@ def create_topics(topics: List[Topic],
63546354
create_timeout: Optional[float] = None)
63556355
```
63566356

6357-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L426)
6357+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L428)
63586358

63596359
Creates topics via an explicit list of provided `Topics`.
63606360

@@ -6376,7 +6376,7 @@ def create_all_topics(timeout: Optional[float] = None,
63766376
create_timeout: Optional[float] = None)
63776377
```
63786378

6379-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L454)
6379+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L456)
63806380

63816381
A convenience method to create all Topic objects stored on this TopicManager.
63826382

@@ -6395,7 +6395,7 @@ If `auto_create_topics` is set to False no topic will be created.
63956395
def validate_all_topics(timeout: Optional[float] = None)
63966396
```
63976397

6398-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L470)
6398+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L472)
63996399

64006400
Validates all topics exist and changelogs have correct topic and rep factor.
64016401

docs/api-reference/topics.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ def topic(name: str,
450450
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
451451
```
452452

453-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L254)
453+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L255)
454454

455455
A convenience method for generating a `Topic`. Will use default config options
456456

@@ -485,7 +485,7 @@ Topic object with creation configs
485485
def register(topic: Topic) -> Topic
486486
```
487487

488-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L300)
488+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L301)
489489

490490
Register an already generated :class:`quixstreams.models.topics.Topic` to the topic manager.
491491

@@ -513,7 +513,7 @@ def repartition_topic(operation: str,
513513
timeout: Optional[float] = None) -> Topic
514514
```
515515

516-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L318)
516+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L319)
517517

518518
Create an internal repartition topic.
519519

@@ -548,7 +548,7 @@ def changelog_topic(topic_name: Optional[str],
548548
timeout: Optional[float] = None) -> Topic
549549
```
550550

551-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L358)
551+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L359)
552552

553553
Performs all the logic necessary to generate a changelog topic based on an
554554

@@ -596,7 +596,7 @@ def create_topics(topics: List[Topic],
596596
create_timeout: Optional[float] = None)
597597
```
598598

599-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L426)
599+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L428)
600600

601601
Creates topics via an explicit list of provided `Topics`.
602602

@@ -622,7 +622,7 @@ def create_all_topics(timeout: Optional[float] = None,
622622
create_timeout: Optional[float] = None)
623623
```
624624

625-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L454)
625+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L456)
626626

627627
A convenience method to create all Topic objects stored on this TopicManager.
628628

@@ -645,7 +645,7 @@ If `auto_create_topics` is set to False no topic will be created.
645645
def validate_all_topics(timeout: Optional[float] = None)
646646
```
647647

648-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L470)
648+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/models/topics/manager.py#L472)
649649

650650
Validates all topics exist and changelogs have correct topic and rep factor.
651651

0 commit comments

Comments
 (0)