Consumer docstring cleanup (#394)

Author: tim-quix

docs/api-reference/application.md

@@ -10,7 +10,7 @@
 class Application()
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/app.py#L56)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/app.py#L56)
 
 The main Application class.
 
@@ -83,7 +83,7 @@ def __init__(broker_address: Optional[Union[str, ConnectionConfig]] = None,
              processing_guarantee: ProcessingGuarantee = "at-least-once")
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/app.py#L94)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/app.py#L94)
 
 
 <br>
@@ -186,7 +186,7 @@ def Quix(
 ) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/app.py#L330)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/app.py#L330)
 
 >***NOTE:*** DEPRECATED: use Application with `quix_sdk_token` argument instead.
 
@@ -297,7 +297,7 @@ def topic(name: str,
           timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/app.py#L471)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/app.py#L471)
 
 Create a topic definition.
 
@@ -378,7 +378,7 @@ topic = app.topic("input-topic", timestamp_extractor=custom_ts_extractor)
 def dataframe(topic: Topic) -> StreamingDataFrame
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/app.py#L551)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/app.py#L551)
 
 A simple helper method that generates a `StreamingDataFrame`, which is used
 
@@ -428,7 +428,7 @@ to be used as an input topic.
 def stop(fail: bool = False)
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/app.py#L590)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/app.py#L590)
 
 Stop the internal poll loop and the message processing.
 
@@ -455,7 +455,7 @@ to unhandled exception, and it shouldn't commit the current checkpoint.
 def get_producer() -> Producer
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/app.py#L613)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/app.py#L613)
 
 Create and return a pre-configured Producer instance.
 The Producer is initialized with params passed to Application.
@@ -490,7 +490,7 @@ with app.get_producer() as producer:
 def get_consumer(auto_commit_enable: bool = True) -> Consumer
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/app.py#L643)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/app.py#L643)
 
 Create and return a pre-configured Consumer instance.
 The Consumer is initialized with params passed to Application.
@@ -539,7 +539,7 @@ with app.get_consumer() as consumer:
 def clear_state()
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/app.py#L690)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/app.py#L690)
 
 Clear the state of the application.
 
@@ -553,7 +553,7 @@ Clear the state of the application.
 def run(dataframe: StreamingDataFrame)
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/app.py#L696)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/app.py#L696)
 
 Start processing data from Kafka using provided `StreamingDataFrame`
 

docs/api-reference/context.md

@@ -12,7 +12,7 @@
 def set_message_context(context: Optional[MessageContext])
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/context.py#L20)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/context.py#L20)
 
 Set a MessageContext for the current message in the given `contextvars.Context`
 
@@ -55,7 +55,7 @@ sdf = sdf.update(lambda value: alter_context(value))
 def message_context() -> MessageContext
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/context.py#L51)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/context.py#L51)
 
 Get a MessageContext for the current message, which houses most of the message
 

docs/api-reference/dataframe.md

@@ -10,7 +10,7 @@
 class StreamingDataFrame(BaseStreaming)
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L62)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L62)
 
 `StreamingDataFrame` is the main object you will use for ETL work.
 
@@ -81,7 +81,7 @@ def apply(func: Union[
           metadata: bool = False) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L177)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L177)
 
 Apply a function to transform the value and return a new value.
 
@@ -139,7 +139,7 @@ def update(func: Union[
            metadata: bool = False) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L266)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L266)
 
 Apply a function to mutate value in-place or to perform a side effect
 
@@ -197,7 +197,7 @@ def filter(func: Union[
            metadata: bool = False) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L354)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L354)
 
 Filter value using provided function.
 
@@ -249,7 +249,7 @@ def group_by(key: Union[str, Callable[[Any], Any]],
              key_serializer: Optional[SerializerType] = "json") -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L440)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L440)
 
 "Groups" messages by re-keying them via the provided group_by operation
 
@@ -314,7 +314,7 @@ a clone with this operation added (assign to keep its effect).
 def contains(key: str) -> StreamingSeries
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L518)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L518)
 
 Check if the key is present in the Row value.
 
@@ -353,7 +353,7 @@ or False otherwise.
 def to_topic(topic: Topic, key: Optional[Callable[[Any], Any]] = None) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L543)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L543)
 
 Produce current value to a topic. You can optionally specify a new key.
 
@@ -396,7 +396,7 @@ By default, the current message key will be used.
 def set_timestamp(func: Callable[[Any, Any, int, Any], int]) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L584)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L584)
 
 Set a new timestamp based on the current message value and its metadata.
 
@@ -449,7 +449,7 @@ def set_headers(
 ) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L625)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L625)
 
 Set new message headers based on the current message value and metadata.
 
@@ -500,7 +500,7 @@ def compose(
 ) -> Dict[str, VoidExecutor]
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L676)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L676)
 
 Compose all functions of this StreamingDataFrame into one big closure.
 
@@ -554,7 +554,7 @@ def test(value: Any,
          topic: Optional[Topic] = None) -> List[Any]
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L713)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L713)
 
 A shorthand to test `StreamingDataFrame` with provided value
 
@@ -591,7 +591,7 @@ def tumbling_window(duration_ms: Union[int, timedelta],
                     name: Optional[str] = None) -> TumblingWindowDefinition
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L750)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L750)
 
 Create a tumbling window transformation on this StreamingDataFrame.
 
@@ -677,7 +677,7 @@ def hopping_window(duration_ms: Union[int, timedelta],
                    name: Optional[str] = None) -> HoppingWindowDefinition
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/dataframe.py#L826)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/dataframe.py#L826)
 
 Create a hopping window transformation on this StreamingDataFrame.
 
@@ -771,7 +771,7 @@ sdf = (
 class StreamingSeries(BaseStreaming)
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L47)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L47)
 
 `StreamingSeries` are typically generated by `StreamingDataframes` when getting
 elements from, or performing certain operations on, a `StreamingDataframe`,
@@ -837,7 +837,7 @@ sdf = sdf[["column_a"] & (sdf["new_sum_field"] >= 10)]
 def from_apply_callback(cls, func: ApplyWithMetadataCallback) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L107)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L107)
 
 Create a StreamingSeries from a function.
 
@@ -865,7 +865,7 @@ instance of `StreamingSeries`
 def apply(func: ApplyCallback) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L121)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L121)
 
 Add a callable to the execution list for this series.
 
@@ -917,7 +917,7 @@ a new `StreamingSeries` with the new callable added
 def compose_returning() -> ReturningExecutor
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L155)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L155)
 
 Compose a list of functions from this StreamingSeries and its parents into one
 
@@ -948,7 +948,7 @@ def compose(
                             None]] = None) -> VoidExecutor
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L170)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L170)
 
 Compose all functions of this StreamingSeries into one big closure.
 
@@ -1006,7 +1006,7 @@ def test(value: Any,
          ctx: Optional[MessageContext] = None) -> Any
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L214)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L214)
 
 A shorthand to test `StreamingSeries` with provided value
 
@@ -1038,7 +1038,7 @@ result of `StreamingSeries`
 def isin(other: Container) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L269)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L269)
 
 Check if series value is in "other".
 
@@ -1083,7 +1083,7 @@ new StreamingSeries
 def contains(other: Union[Self, object]) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L296)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L296)
 
 Check if series value contains "other"
 
@@ -1128,7 +1128,7 @@ new StreamingSeries
 def is_(other: Union[Self, object]) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L321)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L321)
 
 Check if series value refers to the same object as `other`
 
@@ -1170,7 +1170,7 @@ new StreamingSeries
 def isnot(other: Union[Self, object]) -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L344)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L344)
 
 Check if series value does not refer to the same object as `other`
 
@@ -1213,7 +1213,7 @@ new StreamingSeries
 def isnull() -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L368)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L368)
 
 Check if series value is None.
 
@@ -1250,7 +1250,7 @@ new StreamingSeries
 def notnull() -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L391)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L391)
 
 Check if series value is not None.
 
@@ -1287,7 +1287,7 @@ new StreamingSeries
 def abs() -> Self
 ```
 
-[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/209d74b1262aa6d90dddd1a01473c83d9d10fdce/quixstreams/dataframe/series.py#L414)
+[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/d1c312905abaa551ea99b4db5afe2a25d428e445/quixstreams/dataframe/series.py#L414)
 
 Get absolute value of the series value.