Merge branch 'main' into version-2

lib/datagrid.rb

@@ -4,7 +4,6 @@
 require "datagrid/configuration"
 require "datagrid/engine"
 
-# @main README.md
 module Datagrid
   # @!visibility private
   def self.included(base)
@@ -19,15 +18,6 @@ def self.included(base)
     end
   end
 
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  # Configure
-  def self.configure(&block)
-    block.call(configuration)
-  end
-
   class ConfigurationError < StandardError; end
   class ArgumentError < ::ArgumentError; end
   class ColumnUnavailableError < StandardError; end

lib/datagrid/configuration.rb

@@ -1,6 +1,20 @@
 # frozen_string_literal: true
 
 module Datagrid
+  # @return [Configuration] current Datagrid configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # @yield block to configure
+  # @yieldparam [Configuration] configuration
+  # @yieldreturn [void]
+  # @return [void] configure datagrid
+  # @see Datagrid::Configuration
+  def self.configure(&block)
+    block.call(configuration)
+  end
+
   # ## Configuration
   #
   # Datagrid provides several configuration options.
@@ -12,7 +26,7 @@ module Datagrid
   #   # Defines date formats that can be used to parse dates.
   #   # Note: Multiple formats can be specified. The first format is used to format dates as strings,
   #   # while other formats are used only for parsing dates from strings (e.g., if your app supports multiple formats).
-  #   config.date_formats = ["%m/%d/%Y", "%Y-%m-%d"]
+  #   config.date_formats = "%m/%d/%Y", "%Y-%m-%d"
   #
   #   # Defines timestamp formats that can be used to parse timestamps.
   #   # Note: Multiple formats can be specified. The first format is used to format timestamps as strings,

lib/datagrid/filters/base_filter.rb

@@ -7,7 +7,6 @@ class FilteringError < StandardError
   end
 end
 
-# @!visibility private
 module Datagrid
   module Filters
     class BaseFilter

lib/datagrid/filters/extended_boolean_filter.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# @!visibility private
 module Datagrid
   module Filters
     class ExtendedBooleanFilter < Datagrid::Filters::EnumFilter

lib/datagrid/generators/scaffold.rb

@@ -2,7 +2,6 @@
 
 require "rails/generators"
 
-# @!visibility private
 module Datagrid
   # @!visibility private
   module Generators