Let's try documenting marketplace

lineofflight · Oct 11, 2024 · 0193f0f · 0193f0f
1 parent d7cbbf3
commit 0193f0f
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/lib/peddler/marketplace.rb b/lib/peddler/marketplace.rb
@@ -29,6 +29,16 @@ module Peddler
     "JP" => { id: "A1VC38T7YXB528", country_name: "Japan", selling_region: "Far East" },
   }
 
+  # @!parse
+  #   # Wraps an Amazon marketplace
+  #   #
+  #   # @api public
+  #   #
+  #   # @!attribute [r] id
+  #   # @!attribute [r] country_code
+  #   # @!attribute [r] country_name
+  #   # @!attribute [r] selling_region
+  #   class Peddler::Marketplace < Data; end
   Marketplace = Data.define(:id, :country_code, :country_name, :selling_region) do
     class << self
       # Finds the marketplace for the given country code