Improve yardoc

lineofflight · Dec 20, 2024 · 09944ec · 09944ec
1 parent 32a3a9f
commit 09944ec
Showing 1 changed file with 3 additions and 2 deletions.
diff --git 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