adjust the docstrings

btschwertfeger · Oct 22, 2023 · 2b286ad · 2b286ad
1 parent e198bbf
commit 2b286ad
Show file tree

Hide file tree

Showing 21 changed files with 496 additions and 396 deletions.
diff --git a/docs/src/base_api/base_api.rst b/docs/src/base_api/base_api.rst
@@ -2,8 +2,8 @@
 .. Copyright (C) 2023 Benjamin Thomas Schwertfeger
 .. GitHub: https://github.com/btschwertfeger
 
-The Base Clients and Internals
-==============================
+Base Clients and Internals
+==========================
 
 The following classes and data structures are listed for completeness. Please
 avoid using them since these are internals and may change without any warning.

diff --git a/docs/src/examples/rest_ws_samples/futures_rest_examples.rst b/docs/src/examples/rest_ws_samples/futures_rest_examples.rst
@@ -3,7 +3,7 @@
 .. Copyright (C) 2023 Benjamin Thomas Schwertfeger
 .. GitHub: https://github.com/btschwertfeger
 
-Futures Rest
+Futures REST
 ------------
 
 The examples presented below serve to demonstrate the usage of the Futures
@@ -19,4 +19,4 @@ individual functions.
 .. literalinclude:: ../../../../examples/futures_examples.py
    :language: python
    :linenos:
-   :caption: Example usages of the REST clients
+   :caption: Example usage of Futures REST clients
diff --git a/docs/src/examples/rest_ws_samples/spot_rest_examples.rst b/docs/src/examples/rest_ws_samples/spot_rest_examples.rst
@@ -2,7 +2,7 @@
 .. Copyright (C) 2023 Benjamin Thomas Schwertfeger
 .. GitHub: https://github.com/btschwertfeger
 
-Spot Rest
+Spot REST
 ---------
 
 The examples presented below serve to demonstrate the usage of the Spot
@@ -18,4 +18,4 @@ individual functions.
 .. literalinclude:: ../../../../examples/spot_examples.py
    :language: python
    :linenos:
-   :caption: Example usages of the REST clients
+   :caption: Example usage of Spot REST clients
diff --git a/docs/src/examples/trading_bot_templates/spot_bot_templates.rst b/docs/src/examples/trading_bot_templates/spot_bot_templates.rst
@@ -5,7 +5,7 @@
 .. The spot trading bot templates
 
 Spot Trading Bot Templates
--------------------------
+--------------------------
 
 The templates presented below serve as starting points for the development of
 a trading algorithms for Spot trading on the cryptocurrency exchange `Kraken`_

diff --git a/kraken/futures/funding.py b/kraken/futures/funding.py
@@ -25,9 +25,11 @@ class Funding(KrakenFuturesBaseAPI):
     :type key: str, optional
     :param secret: Futures API secret key (default: ``""``)
     :type secret: str, optional
-    :param url: Alternative URL to access the Futures Kraken API (default: https://futures.kraken.com)
+    :param url: Alternative URL to access the Futures Kraken API (default:
+        https://futures.kraken.com)
     :type url: str, optional
-    :param sandbox: If set to ``True`` the URL will be https://demo-futures.kraken.com (default: ``False``)
+    :param sandbox: If set to ``True`` the URL will be
+        https://demo-futures.kraken.com (default: ``False``)
     :type sandbox: bool, optional
 
     .. code-block:: python
@@ -68,7 +70,8 @@ def get_historical_funding_rates(
         extra_params: Optional[dict] = None,
     ) -> dict:
         """
-        Retrieve information about the historical funding rates of a specific ``symbol``
+        Retrieve information about the historical funding rates of a specific
+        ``symbol``
 
         - https://docs.futures.kraken.com/#http-api-trading-v3-api-historical-funding-rates-historicalfundingrates
 
@@ -115,10 +118,11 @@ def initiate_wallet_transfer(
         extra_params: Optional[dict] = None,
     ) -> dict:
         """
-        Submit a wallet transfer request to transfer funds between margin accounts.
+        Submit a wallet transfer request to transfer funds between margin
+        accounts.
 
-        Requires the ``General API - Full Access`` and ``Withdrawal API - Full access``
-        permissions in the API key settings.
+        Requires the ``General API - Full Access`` and ``Withdrawal API - Full
+        access`` permissions in the API key settings.
 
         - https://docs.futures.kraken.com/#http-api-trading-v3-api-transfers-initiate-wallet-transfer
 
@@ -175,8 +179,8 @@ def initiate_subaccount_transfer(
         """
         Submit a request to transfer funds between the regular and subaccount.
 
-        Requires the ``General API - Full Access`` and ``Withdrawal API - Full access``
-        permissions in the API key settings.
+        Requires the ``General API - Full Access`` and ``Withdrawal API - Full
+        access`` permissions in the API key settings.
 
         - https://docs.futures.kraken.com/#http-api-trading-v3-api-transfers-initiate-sub-account-transfer
 
@@ -232,8 +236,8 @@ def initiate_withdrawal_to_spot_wallet(
         """
         Enables the transfer of funds between the futures and spot wallet.
 
-        Requires the ``General API - Full Access`` and ``Withdrawal API - Full access``
-        permissions in the API key settings.
+        Requires the ``General API - Full Access`` and ``Withdrawal API - Full
+        access`` permissions in the API key settings.
 
         - https://docs.futures.kraken.com/#http-api-trading-v3-api-transfers-initiate-withdrawal-to-spot-wallet
 
@@ -243,7 +247,8 @@ def initiate_withdrawal_to_spot_wallet(
         :type currency: str
         :param sourceWallet: The wallet to withdraw from (default: ``cash``)
         :type sourceWallet: str, optional
-        :raises ValueError: If this function is called within the sandbox/demo environment
+        :raises ValueError: If this function is called within the sandbox/demo
+            environment
 
         .. code-block:: python
             :linenos: