Improve comments and indentation [skip-log]

ddnexus · Nov 18, 2024 · 30d48c2 · 30d48c2
1 parent 079fe81
commit 30d48c2
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 10 deletions.
diff --git a/gem/bin/pagy b/gem/bin/pagy
@@ -28,10 +28,10 @@ opts = Optimist.options do
       pagy ~/my-repro.ru         Develop ~/my-repro.ru at#{HOST}:#{PORT}
   HEAD
   text 'Rackup options'
-  opt :env,     'Environment', default: 'development'
-  opt :host,    'Host', default: HOST, short: :o
-  opt :port,    'Port', default: PORT
-  opt :install, 'Install bundle for users', default: true
+  opt :env,     'Environment',                  default: 'development'
+  opt :host,    'Host',                         default: HOST, short: :o
+  opt :port,    'Port',                         default: PORT
+  opt :install, 'Install bundle for users',     default: true
   if LINUX
     text 'Rerun options'
     opt :rerun, 'Enable rerun for development', default: true

diff --git a/gem/lib/pagy/calendar/day.rb b/gem/lib/pagy/calendar/day.rb
@@ -12,7 +12,7 @@ class Day < Unit
 
       protected
 
-      # Setup the calendar variables
+      # Set up the calendar variables
       def assign_unit_vars
         super
         @initial = @starting.beginning_of_day

diff --git a/gem/lib/pagy/calendar/month.rb b/gem/lib/pagy/calendar/month.rb
@@ -12,7 +12,7 @@ class Month < Unit
 
       protected
 
-      # Setup the calendar variables
+      # Set up the calendar variables
       def assign_unit_vars
         super
         @initial = @starting.beginning_of_month

diff --git a/gem/lib/pagy/calendar/quarter.rb b/gem/lib/pagy/calendar/quarter.rb
@@ -19,7 +19,7 @@ def label_for(page, opts = {})
 
       protected
 
-      # Setup the calendar variables
+      # Set up the calendar variables
       def assign_unit_vars
         super
         @initial = @starting.beginning_of_quarter

diff --git a/gem/lib/pagy/calendar/week.rb b/gem/lib/pagy/calendar/week.rb
@@ -10,7 +10,7 @@ class Week < Unit
 
       protected
 
-      # Setup the calendar variables
+      # Set up the calendar variables
       def assign_unit_vars
         super
         @initial = @starting.beginning_of_week

diff --git a/gem/lib/pagy/calendar/year.rb b/gem/lib/pagy/calendar/year.rb
@@ -12,7 +12,7 @@ class Year < Unit
 
       protected
 
-      # Setup the calendar variables
+      # Set up the calendar variables
       def assign_unit_vars
         super
         @initial = @starting.beginning_of_year

diff --git a/gem/lib/pagy/keyset.rb b/gem/lib/pagy/keyset.rb
@@ -79,7 +79,16 @@ def records
 
     protected
 
-    # Prepare the literal query to filter the newest records
+    # Prepare the literal query string (complete with the placeholders for value interpolation)
+    # used to filter the newest records.
+    # For example:
+    # With a set like Pet.order(animal: :asc, name: :desc, id: :asc) it returns the following string:
+    # ( animal = :animal AND name = :name AND id > :id ) OR
+    # ( animal = :animal AND name < :name ) OR
+    # ( animal > :animal )
+    # When :tuple_comparison is enabled, and if the order is all :asc or all :desc,
+    # with a set like Pet.order(:animal, :name, :id) it returns the following string:
+    # ( animal, name, id ) > ( :animal, :name, :id )
     def filter_newest_query
       operator   = { asc: '>', desc: '<' }
       directions = @keyset.values