From 09944ec1e6168a4b49ff4fff9d59663614043099 Mon Sep 17 00:00:00 2001
From: Hakan Ensari <hakanensari@gmail.com>
Date: Fri, 20 Dec 2024 23:03:54 +0100
Subject: [PATCH] Improve yardoc

---
 lib/peddler/api.rb | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lib/peddler/api.rb b/lib/peddler/api.rb
index 97f4216b..2ac45632 100644
--- a/lib/peddler/api.rb
+++ b/lib/peddler/api.rb
@@ -30,8 +30,9 @@ class << self
     # @return [Integer]
     attr_reader :retries
 
-    # @param [String] aws_region
-    # @param [String] access_token
+    # @param [String] aws_region The AWS region to use for the endpoint
+    # @param [String] access_token The access token for authentication
+    # @param [Integer] retries The number of retries if throttled (default: 0)
     def initialize(aws_region, access_token, retries: 0)
       @endpoint = Endpoint.find(aws_region)
       @access_token = access_token