fix: formattings for multiline params docstrings

Author: ytkimirti

qstash/asyncio/dlq.py

@@ -39,7 +39,7 @@ async def list(
         Lists all messages currently inside the DLQ.
 
         :param cursor: Optional cursor to start listing DLQ messages from.
-        :param count: The maximum number of DLQ messages to return.
+        :param count: The maximum number of DLQ messages to return. \
             Default and max is `100`.
         :param filter: Filter to use.
         """

qstash/asyncio/log.py

@@ -24,7 +24,7 @@ async def list(
         Lists all logs that happened, such as message creation or delivery.
 
         :param cursor: Optional cursor to start listing logs from.
-        :param count: The maximum number of logs to return.
+        :param count: The maximum number of logs to return. \
             Default and max is `1000`.
         :param filter: Filter to use.
         """

qstash/asyncio/message.py

@@ -70,28 +70,28 @@ async def publish(
         :param method: The HTTP method to use when sending a webhook to your API.
         :param headers: Headers to forward along with the message.
         :param callback_headers: Headers to forward along with the callback message.
-        :param failure_callback_headers: Headers to forward along with the failure
+        :param failure_callback_headers: Headers to forward along with the failure \
             callback message.
-        :param retries: How often should this message be retried in case the destination
+        :param retries: How often should this message be retried in case the destination \
             API is not available.
         :param callback: A callback url that will be called after each attempt.
-        :param failure_callback: A failure callback url that will be called when a delivery
+        :param failure_callback: A failure callback url that will be called when a delivery \
             is failed, that is when all the defined retries are exhausted.
-        :param delay: Delay the message delivery. The format for the delay string is a
-            number followed by duration abbreviation, like `10s`. Available durations
-            are `s` (seconds), `m` (minutes), `h` (hours), and `d` (days). As convenience,
-            it is also possible to specify the delay as an integer, which will be
+        :param delay: Delay the message delivery. The format for the delay string is a \
+            number followed by duration abbreviation, like `10s`. Available durations \
+            are `s` (seconds), `m` (minutes), `h` (hours), and `d` (days). As convenience, \
+            it is also possible to specify the delay as an integer, which will be \
             interpreted as delay in seconds.
-        :param not_before: Delay the message until a certain time in the future.
+        :param not_before: Delay the message until a certain time in the future. \
             The format is a unix timestamp in seconds, based on the UTC timezone.
         :param deduplication_id: Id to use while deduplicating messages.
-        :param content_based_deduplication: Automatically deduplicate messages based on
+        :param content_based_deduplication: Automatically deduplicate messages based on \
             their content.
-        :param timeout: The HTTP timeout value to use while calling the destination URL.
-            When a timeout is specified, it will be used instead of the maximum timeout
-            value permitted by the QStash plan. It is useful in scenarios, where a message
+        :param timeout: The HTTP timeout value to use while calling the destination URL. \
+            When a timeout is specified, it will be used instead of the maximum timeout \
+            value permitted by the QStash plan. It is useful in scenarios, where a message \
             should be delivered with a shorter timeout.
-        :param flow_control: Settings for controlling the number of active requests,
+        :param flow_control: Settings for controlling the number of active requests, \
             as well as the rate of requests with the same flow control key.
         """
         headers = headers or {}
@@ -163,33 +163,33 @@ async def publish_json(
         :param url: Url to send the message to.
         :param url_group: Url group to send the message to.
         :param api: Api to send the message to.
-        :param body: The request message body passed to the destination after being
+        :param body: The request message body passed to the destination after being \
             serialized as JSON string.
         :param method: The HTTP method to use when sending a webhook to your API.
         :param headers: Headers to forward along with the message.
         :param callback_headers: Headers to forward along with the callback message.
-        :param failure_callback_headers: Headers to forward along with the failure
+        :param failure_callback_headers: Headers to forward along with the failure \
             callback message.
-        :param retries: How often should this message be retried in case the destination
+        :param retries: How often should this message be retried in case the destination \
             API is not available.
         :param callback: A callback url that will be called after each attempt.
-        :param failure_callback: A failure callback url that will be called when a delivery
+        :param failure_callback: A failure callback url that will be called when a delivery \
             is failed, that is when all the defined retries are exhausted.
-        :param delay: Delay the message delivery. The format for the delay string is a
-            number followed by duration abbreviation, like `10s`. Available durations
-            are `s` (seconds), `m` (minutes), `h` (hours), and `d` (days). As convenience,
-            it is also possible to specify the delay as an integer, which will be
+        :param delay: Delay the message delivery. The format for the delay string is a \
+            number followed by duration abbreviation, like `10s`. Available durations \
+            are `s` (seconds), `m` (minutes), `h` (hours), and `d` (days). As convenience, \
+            it is also possible to specify the delay as an integer, which will be \
             interpreted as delay in seconds.
-        :param not_before: Delay the message until a certain time in the future.
+        :param not_before: Delay the message until a certain time in the future. \
             The format is a unix timestamp in seconds, based on the UTC timezone.
         :param deduplication_id: Id to use while deduplicating messages.
-        :param content_based_deduplication: Automatically deduplicate messages based on
+        :param content_based_deduplication: Automatically deduplicate messages based on \
             their content.
-        :param timeout: The HTTP timeout value to use while calling the destination URL.
-            When a timeout is specified, it will be used instead of the maximum timeout
-            value permitted by the QStash plan. It is useful in scenarios, where a message
+        :param timeout: The HTTP timeout value to use while calling the destination URL. \
+            When a timeout is specified, it will be used instead of the maximum timeout \
+            value permitted by the QStash plan. It is useful in scenarios, where a message \
             should be delivered with a shorter timeout.
-        :param flow_control: Settings for controlling the number of active requests,
+        :param flow_control: Settings for controlling the number of active requests, \
             as well as the rate of requests with the same flow control key.
         """
         return await self.publish(
@@ -253,19 +253,19 @@ async def enqueue(
         :param method: The HTTP method to use when sending a webhook to your API.
         :param headers: Headers to forward along with the message.
         :param callback_headers: Headers to forward along with the callback message.
-        :param failure_callback_headers: Headers to forward along with the failure
+        :param failure_callback_headers: Headers to forward along with the failure \
             callback message.
-        :param retries: How often should this message be retried in case the destination
+        :param retries: How often should this message be retried in case the destination \
             API is not available.
         :param callback: A callback url that will be called after each attempt.
-        :param failure_callback: A failure callback url that will be called when a delivery
+        :param failure_callback: A failure callback url that will be called when a delivery \
             is failed, that is when all the defined retries are exhausted.
         :param deduplication_id: Id to use while deduplicating messages.
-        :param content_based_deduplication: Automatically deduplicate messages based on
+        :param content_based_deduplication: Automatically deduplicate messages based on \
             their content.
-        :param timeout: The HTTP timeout value to use while calling the destination URL.
-            When a timeout is specified, it will be used instead of the maximum timeout
-            value permitted by the QStash plan. It is useful in scenarios, where a message
+        :param timeout: The HTTP timeout value to use while calling the destination URL. \
+            When a timeout is specified, it will be used instead of the maximum timeout \
+            value permitted by the QStash plan. It is useful in scenarios, where a message \
             should be delivered with a shorter timeout.
         """
         headers = headers or {}
@@ -342,19 +342,19 @@ async def enqueue_json(
         :param method: The HTTP method to use when sending a webhook to your API.
         :param headers: Headers to forward along with the message.
         :param callback_headers: Headers to forward along with the callback message.
-        :param failure_callback_headers: Headers to forward along with the failure
+        :param failure_callback_headers: Headers to forward along with the failure \
             callback message.
-        :param retries: How often should this message be retried in case the destination
+        :param retries: How often should this message be retried in case the destination \
             API is not available.
         :param callback: A callback url that will be called after each attempt.
-        :param failure_callback: A failure callback url that will be called when a delivery
+        :param failure_callback: A failure callback url that will be called when a delivery \
             is failed, that is when all the defined retries are exhausted.
         :param deduplication_id: Id to use while deduplicating messages.
-        :param content_based_deduplication: Automatically deduplicate messages based on
+        :param content_based_deduplication: Automatically deduplicate messages based on \
             their content.
-        :param timeout: The HTTP timeout value to use while calling the destination URL.
-            When a timeout is specified, it will be used instead of the maximum timeout
-            value permitted by the QStash plan. It is useful in scenarios, where a message
+        :param timeout: The HTTP timeout value to use while calling the destination URL. \
+            When a timeout is specified, it will be used instead of the maximum timeout \
+            value permitted by the QStash plan. It is useful in scenarios, where a message \
             should be delivered with a shorter timeout.
         """
         return await self.enqueue(

qstash/asyncio/queue.py

@@ -20,7 +20,7 @@ async def upsert(
 
         :param queue: The name of the queue.
         :param parallelism: The number of parallel consumers consuming from the queue.
-        :param paused: Whether to pause the queue or not. A paused queue will not
+        :param paused: Whether to pause the queue or not. A paused queue will not \
             deliver new messages until it is resumed.
         """
         body = prepare_upsert_body(queue, parallelism, paused)

qstash/asyncio/schedule.py

@@ -47,26 +47,26 @@ async def create(
         :param method: The HTTP method to use when sending a webhook to your API.
         :param headers: Headers to forward along with the message.
         :param callback_headers: Headers to forward along with the callback message.
-        :param failure_callback_headers: Headers to forward along with the failure
+        :param failure_callback_headers: Headers to forward along with the failure \
             callback message.
-        :param retries: How often should this message be retried in case the destination
+        :param retries: How often should this message be retried in case the destination \
             API is not available.
         :param callback: A callback url that will be called after each attempt.
-        :param failure_callback: A failure callback url that will be called when a delivery
+        :param failure_callback: A failure callback url that will be called when a delivery \
             is failed, that is when all the defined retries are exhausted.
-        :param delay: Delay the message delivery. The format for the delay string is a
-            number followed by duration abbreviation, like `10s`. Available durations
-            are `s` (seconds), `m` (minutes), `h` (hours), and `d` (days). As convenience,
-            it is also possible to specify the delay as an integer, which will be
+        :param delay: Delay the message delivery. The format for the delay string is a \
+            number followed by duration abbreviation, like `10s`. Available durations \
+            are `s` (seconds), `m` (minutes), `h` (hours), and `d` (days). As convenience, \
+            it is also possible to specify the delay as an integer, which will be \
             interpreted as delay in seconds.
-        :param timeout: The HTTP timeout value to use while calling the destination URL.
-            When a timeout is specified, it will be used instead of the maximum timeout
-            value permitted by the QStash plan. It is useful in scenarios, where a message
+        :param timeout: The HTTP timeout value to use while calling the destination URL. \
+            When a timeout is specified, it will be used instead of the maximum timeout \
+            value permitted by the QStash plan. It is useful in scenarios, where a message \
             should be delivered with a shorter timeout.
-        :param schedule_id: Schedule id to use. This can be used to update the settings
+        :param schedule_id: Schedule id to use. This can be used to update the settings \
             of an existing schedule.
-        :param queue: Name of the queue which the scheduled messages will be enqueued.
-        :param flow_control: Settings for controlling the number of active requests,
+        :param queue: Name of the queue which the scheduled messages will be enqueued. 
+        :param flow_control: Settings for controlling the number of active requests, \
             as well as the rate of requests with the same flow control key.
         """
         req_headers = prepare_schedule_headers(
@@ -122,31 +122,31 @@ async def create_json(
 
         :param destination: The destination url or url group.
         :param cron: The cron expression to use to schedule the messages.
-        :param body: The request message body passed to the destination after being
+        :param body: The request message body passed to the destination after being \
             serialized as JSON string.
         :param method: The HTTP method to use when sending a webhook to your API.
         :param headers: Headers to forward along with the message.
         :param callback_headers: Headers to forward along with the callback message.
-        :param failure_callback_headers: Headers to forward along with the failure
+        :param failure_callback_headers: Headers to forward along with the failure \
             callback message.
-        :param retries: How often should this message be retried in case the destination
+        :param retries: How often should this message be retried in case the destination \
             API is not available.
         :param callback: A callback url that will be called after each attempt.
-        :param failure_callback: A failure callback url that will be called when a delivery
+        :param failure_callback: A failure callback url that will be called when a delivery \
             is failed, that is when all the defined retries are exhausted.
-        :param delay: Delay the message delivery. The format for the delay string is a
-            number followed by duration abbreviation, like `10s`. Available durations
-            are `s` (seconds), `m` (minutes), `h` (hours), and `d` (days). As convenience,
-            it is also possible to specify the delay as an integer, which will be
+        :param delay: Delay the message delivery. The format for the delay string is a \
+            number followed by duration abbreviation, like `10s`. Available durations \
+            are `s` (seconds), `m` (minutes), `h` (hours), and `d` (days). As convenience, \
+            it is also possible to specify the delay as an integer, which will be \
             interpreted as delay in seconds.
-        :param timeout: The HTTP timeout value to use while calling the destination URL.
-            When a timeout is specified, it will be used instead of the maximum timeout
-            value permitted by the QStash plan. It is useful in scenarios, where a message
+        :param timeout: The HTTP timeout value to use while calling the destination URL. \
+            When a timeout is specified, it will be used instead of the maximum timeout \
+            value permitted by the QStash plan. It is useful in scenarios, where a message \
             should be delivered with a shorter timeout.
-        :param schedule_id: Schedule id to use. This can be used to update the settings
+        :param schedule_id: Schedule id to use. This can be used to update the settings \
             of an existing schedule.
         :param queue: Name of the queue which the scheduled messages will be enqueued.
-        :param flow_control: Settings for controlling the number of active requests,
+        :param flow_control: Settings for controlling the number of active requests, \
             as well as the rate of requests with the same flow control key.
         """
         return await self.create(

qstash/dlq.py

@@ -177,7 +177,7 @@ def list(
         Lists all messages currently inside the DLQ.
 
         :param cursor: Optional cursor to start listing DLQ messages from.
-        :param count: The maximum number of DLQ messages to return.
+        :param count: The maximum number of DLQ messages to return. \
             Default and max is `100`.
         :param filter: Filter to use.
         """

qstash/log.py

@@ -252,7 +252,7 @@ def list(
         Lists all logs that happened, such as message creation or delivery.
 
         :param cursor: Optional cursor to start listing logs from.
-        :param count: The maximum number of logs to return.
+        :param count: The maximum number of logs to return. \
             Default and max is `1000`.
         :param filter: Filter to use.
         """