Update Pagy:: Backend comment (#745)

Co-authored-by: Ben Koshy <[email protected]>
ddnexus · Nov 18, 2024 · 2013a80 · 2013a80
1 parent 0475ba4
commit 2013a80
Show file tree

Hide file tree

Showing 14 changed files with 15 additions and 1 deletion.
diff --git a/gem/lib/pagy/backend.rb b/gem/lib/pagy/backend.rb
@@ -1,9 +1,10 @@
 # See Pagy::Backend API documentation: https://ddnexus.github.io/pagy/docs/api/backend
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 class Pagy
   # Define a few generic methods to paginate a collection out of the box,
-  # or any collection by overriding pagy_get_items and/or pagy_get_vars in your controller
+  # or any collection by overriding any of the `pagy_get_*` methods in your controller.
   # See also the extras if you need specialized methods to paginate Arrays or other collections
   module Backend
     private

diff --git a/gem/lib/pagy/extras/arel.rb b/gem/lib/pagy/extras/arel.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/arel
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 class Pagy # :nodoc:
   # Better performance of grouped ActiveRecord collections

diff --git a/gem/lib/pagy/extras/array.rb b/gem/lib/pagy/extras/array.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/array
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 class Pagy # :nodoc:
   # Paginate arrays efficiently, avoiding expensive array-wrapping and without overriding

diff --git a/gem/lib/pagy/extras/calendar.rb b/gem/lib/pagy/extras/calendar.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/calendar
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 require_relative '../calendar'
 

diff --git a/gem/lib/pagy/extras/countless.rb b/gem/lib/pagy/extras/countless.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/countless
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 require_relative '../countless'
 

diff --git a/gem/lib/pagy/extras/elasticsearch_rails.rb b/gem/lib/pagy/extras/elasticsearch_rails.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/elasticsearch_rails
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 class Pagy # :nodoc:
   DEFAULT[:elasticsearch_rails_search]      ||= :search

diff --git a/gem/lib/pagy/extras/headers.rb b/gem/lib/pagy/extras/headers.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/headers
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 require_relative '../url_helpers'
 

diff --git a/gem/lib/pagy/extras/jsonapi.rb b/gem/lib/pagy/extras/jsonapi.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/jsonapi
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 require_relative '../url_helpers'
 

diff --git a/gem/lib/pagy/extras/keyset.rb b/gem/lib/pagy/extras/keyset.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/keyset
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 require_relative '../keyset'
 

diff --git a/gem/lib/pagy/extras/limit.rb b/gem/lib/pagy/extras/limit.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/limit
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 require_relative 'js_tools'
 

diff --git a/gem/lib/pagy/extras/meilisearch.rb b/gem/lib/pagy/extras/meilisearch.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/meilisearch
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 class Pagy # :nodoc:
   DEFAULT[:meilisearch_search]      ||= :ms_search

diff --git a/gem/lib/pagy/extras/metadata.rb b/gem/lib/pagy/extras/metadata.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/metadata
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 require_relative '../url_helpers'
 

diff --git a/gem/lib/pagy/extras/searchkick.rb b/gem/lib/pagy/extras/searchkick.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/searchkick
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 class Pagy # :nodoc:
   DEFAULT[:searchkick_search]      ||= :search

diff --git a/gem/lib/pagy/extras/size.rb b/gem/lib/pagy/extras/size.rb
@@ -1,5 +1,6 @@
 # See the Pagy documentation: https://ddnexus.github.io/pagy/docs/extras/size
 # frozen_string_literal: true
+# You can override any of the `pagy_*` methods in your controller.
 
 class Pagy # :nodoc:
   # Implement the legacy bar using the array size.