adding simple example

manuelarte · Nov 9, 2024 · 9d1dd55 · 9d1dd55
1 parent f340eb5
commit 9d1dd55
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,8 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### TODO
 
-- Use uint instead of int
 - Add code coverage badge
+- Check for fmt
 - Add more examples
 
 ### Added

diff --git a/model.go b/model.go
@@ -23,6 +23,7 @@ type PageRequest interface {
 	IsUnPaged() bool
 }
 
+// PageRequestOf Creates a PageRequest with the page and size values
 func PageRequestOf(page, size int) (PageRequest, error) {
 	if page < 0 {
 		return nil, ErrPageCantBeNegative
@@ -36,6 +37,7 @@ func PageRequestOf(page, size int) (PageRequest, error) {
 	return &internal.PageRequestImpl{Page: page, Size: size}, nil
 }
 
+// UnPaged Create an unpaged request (no pagination is applied)
 func UnPaged() PageRequest {
 	return &internal.PageRequestImpl{Page: 0, Size: 0}
 }