cw_card_utils 0.1.11 → 0.1.12

data/lib/cw_card_utils.rb

@@ -7,17 +7,37 @@ require_relative "cw_card_utils/scryfall_cmc_data"
 require_relative "cw_card_utils/synergy_probability"
 require_relative "cw_card_utils/deck_comparator"
 
+##
+# Public: Top-level namespace for Card Utils.
+# 日本語: Card Utils のトップレベル名前空間です。
 module CwCardUtils
+  ##
+  # Public: Gem-specific error base class.
+  # 日本語: このライブラリ用の基本的なエラークラスです。
   class Error < StandardError; end
 
-  # Configuration for the library
+  # Public: Configuration for the library.
+  # 日本語: ライブラリの設定を行います。
   class << self
+    # Public: Overrides the global card data source.
+    # 日本語: グローバルなカードデータソースを上書きします。
+    #
+    # @param source [CwCardUtils::CardDataSource]
     attr_writer :card_data_source
 
+    # Public: Returns the global card data source used by parsers and models.
+    # 日本語: パーサやモデルが使用するグローバルなカードデータソースを返します。
+    #
+    # @return [CwCardUtils::CardDataSource]
     def card_data_source
       @card_data_source ||= ScryfallCmcData.instance
     end
 
+    # Public: Yields the module for configuration.
+    # 日本語: 設定用にモジュール自身をブロックに渡します。
+    #
+    # @yield [CwCardUtils]
+    # @return [void]
     def configure
       yield self if block_given?
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cw_card_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Ryan Stenhouse
@@ -57,6 +57,7 @@ metadata:
   homepage_uri: https://cracklingwit.com
   source_code_uri: https://github.com/cracklingwit/card_utils
   changelog_uri: https://github.com/cracklingwit/card_utils/commits/main/
+  documentation_uri: https://card-utils.rdoc.cracklingwit.com
 rdoc_options: []
 require_paths:
 - lib