Update docstring param & return syntax

Author: Invincibear

paddle_billing/Logger/__init__.py

@@ -9,9 +9,9 @@ def get_logger(
     """
     Configures a logger instance that our Client() uses
 
-    @param log_level:     Defaults to logging.INFO
-    @param log_file_path: Defaults to None, which streams logs to the console. If a file path is provided logs are written to the file.
-    @return:              Returns a logger instance
+    :param log_level:     Defaults to logging.INFO
+    :param log_file_path: Defaults to None, which streams logs to the console. If a file path is provided logs are written to the file.
+    :return:              Returns a logger instance
     """
     logger = logging.getLogger('paddle_billing')
 

paddle_billing/Notifications/PaddleSignature.py

@@ -32,8 +32,8 @@ def parse(signature_header: str) -> tuple:
         """
         Parse the Paddle-Signature header to extract the timestamp and signature
 
-        @param   signature_header: The Paddle-Signature key=value from the webhook event's headers
-        @return:                   A tuple containing (timestamp, signature)
+        :param   signature_header: The Paddle-Signature key=value from the webhook event's headers
+        :return:                   A tuple containing (timestamp, signature)
         """
         components = {
             PaddleSignature().TIMESTAMP: 0,
@@ -70,10 +70,10 @@ def __do_verify(self, timestamp: str, signatures: list[str], raw_body: str, secr
         Verifies an individual secret key against a Paddle-Signature header.
         Called by PaddleSignature.verify()
 
-        @param signatures: The Paddle-Signature header
-        @param raw_body:   Raw body of the webhook request
-        @param secret_key: A Paddle secret key: https://developer.paddle.com/webhooks/signature-verification#get-secret-key
-        @return:           True on verification success, False on verification failure
+        :param signatures: The Paddle-Signature header
+        :param raw_body:   Raw body of the webhook request
+        :param secret_key: A Paddle secret key: https://developer.paddle.com/webhooks/signature-verification#get-secret-key
+        :return:           True on verification success, False on verification failure
         """
         new_body_to_verify  = f"{timestamp}:{raw_body}".encode('utf-8')
         generated_signature = PaddleSignature.calculate_hmac(secret_key.secret_key, new_body_to_verify).hexdigest()
@@ -95,10 +95,10 @@ def verify(self, signature_header: str, raw_body: str, secrets: list[Secret] | S
         Performs an integrity check on a Paddle webhook's signature against one or more Secrets
         Handling multiple Secrets is needed because of key rotation situations
 
-        @param signature_header: The Paddle-Signature header
-        @param raw_body:         Raw body of the webhook request
-        @param secrets:          One or more Paddle secret key(s): https://developer.paddle.com/webhooks/signature-verification#get-secret-key
-        @return:                 True if any secret key passes verification success. Raises a ConnectionRefusedError if all secret keys fail verification
+        :param signature_header: The Paddle-Signature header
+        :param raw_body:         Raw body of the webhook request
+        :param secrets:          One or more Paddle secret key(s): https://developer.paddle.com/webhooks/signature-verification#get-secret-key
+        :return:                 True if any secret key passes verification success. Raises a ConnectionRefusedError if all secret keys fail verification
         """
         is_list   = type(secrets) is list
         key_count = 'multiple secret keys' if is_list else 'one secret key'

paddle_billing/Notifications/Verifier.py

@@ -24,10 +24,10 @@ def maximum_variance(self) -> int:
 
     def verify(self, request: requests, secrets: list[Secret] | Secret, verify_time_drift = True):
         """
-        @param request:           The request object to verify
-        @param secrets:           One or more Secrets to use for verifying the request
-        @param verify_time_drift: Defaults to True. Set False to disable time drift verification (NOT RECOMMENDED, counters MITM attacks)
-        @return:                  True on verification success, False on verification failure
+        :param request:           The request object to verify
+        :param secrets:           One or more Secrets to use for verifying the request
+        :param verify_time_drift: Defaults to True. Set False to disable time drift verification (NOT RECOMMENDED, counters MITM attacks)
+        :return:                  True on verification success, False on verification failure
         """
         self.log.info(f"Attempting to verify the authenticity of a request")