mention underlying implementation in the docs of pagination type

woylie · Jul 30, 2024 · 77dbd70 · 77dbd70
1 parent 217b211
commit 77dbd70
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lib/flop.ex b/lib/flop.ex
@@ -489,8 +489,8 @@ defmodule Flop do
   @typedoc """
   Represents the pagination type.
 
-  - `:offset` - pagination using the `offset` and `limit` parameters
-  - `:page` - pagination using the `page` and `page_size` parameters
+  - `:offset` - offset-based pagination using the `offset` and `limit` parameters
+  - `:page` - offset-based pagination using the `page` and `page_size` parameters
   - `:first` - cursor-based pagination using the `first` and `after` parameters
   - `:last` - cursor-based pagination using the `last` and `before` parameters
   """