Bumped up ellar version and some code docs

eadwinCode · eadwinCode · commit 5d96d8b99f25 · 2024-01-16T11:51:38.000+01:00
diff --git a/ellar_sqlalchemy/pagination/base.py b/ellar_sqlalchemy/pagination/base.py
@@ -126,12 +126,12 @@ def pages(self) -> int:
 
     @property
     def has_prev(self) -> bool:
-        """``True`` if this is not the first page."""
+        """`True` if this is not the first page."""
         return self.page > 1
 
     @property
     def prev_num(self) -> t.Optional[int]:
-        """The previous page number, or ``None`` if this is the first page."""
+        """The previous page number, or `None` if this is the first page."""
         if not self.has_prev:
             return None
 
@@ -140,9 +140,8 @@ def prev_num(self) -> t.Optional[int]:
     def prev(self, *, error_out: bool = False) -> "PaginatorBase":
         """Query the pagination object for the previous page.
 
-        :param error_out: Abort with a ``404 Not Found`` error if no items are returned
-            and ``page`` is not 1, or if ``page`` or ``per_page`` is less than 1, or if
-            either are not ints.
+        :param error_out: Raise `404 Not Found` error if no items are returned
+            and `page` is not 1, or if `page` or `per_page` is less than 1.
         """
         init_kwargs = self._get_init_kwargs()
         init_kwargs.update(
@@ -157,19 +156,24 @@ def prev(self, *, error_out: bool = False) -> "PaginatorBase":
 
     @property
     def has_next(self) -> bool:
-        """``True`` if this is not the last page."""
+        """`True` if this is not the last page."""
         return self.page < self.pages
 
     @property
     def next_num(self) -> t.Optional[int]:
-        """The next page number, or ``None`` if this is the last page."""
+        """The next page number, or `None` if this is the last page."""
         if not self.has_next:
             return None
 
         return self.page + 1
 
     def next(self, *, error_out: bool = False) -> "PaginatorBase":
-        """ """
+        """
+        Query the Pagination object for the next page.
+
+        :param error_out: Raise `404 Not Found` error if no items are returned
+            and `page` is not 1, or if `page` or `per_page` is less than 1.
+        """
         init_kwargs = self._get_init_kwargs()
         init_kwargs.update(
             page=self.page + 1,
@@ -190,15 +194,15 @@ def iter_pages(
         right_current: int = 4,
         right_edge: int = 2,
     ) -> t.Iterator[t.Optional[int]]:
-        """Yield page numbers for a pagination widget. Skipped pages between the edges
-        and middle are represented by a ``None``.
+        """
+        Yield page numbers for a pagination widget.
+        A None represents skipped pages between the edges and middle.
 
         For example, if there are 20 pages and the current page is 7, the following
         values are yielded.
 
-        .. code-block:: python
-
-            1, 2, None, 5, 6, 7, 8, 9, 10, 11, None, 19, 20
+        For example:
+        1, 2, None, 5, 6, 7, 8, 9, 10, 11, None, 19, 20
 
         :param left_edge: How many pages to show from the first page.
         :param left_current: How many pages to show left of the current page.
diff --git a/ellar_sqlalchemy/pagination/decorator.py b/ellar_sqlalchemy/pagination/decorator.py
@@ -24,11 +24,11 @@ def paginate(
     """
     =========ROUTE FUNCTION DECORATOR ==============
 
-    # :param ttl: the time to live
-    # :param key_prefix: cache key prefix
-    # :param version: will be used in constructing the key
-    # :param backend: Cache Backend to use. Default is `default`
-    # :param make_key_callback: Key dynamic construct.
+    :param pagination_class: Pagination Class of type PaginationBase
+    :param model: SQLAlchemy Model or SQLAlchemy Select Statement
+    :param template_context: If True adds `paginator` object to templating context data
+    :param item_schema: Pagination Object Schema for serializing object and creating response schema documentation
+    :param paginator_options: Other keyword args for initializing `pagination_class`
     :return: TCallable
     """
     paginator_options.update(model=model)
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,7 +32,7 @@ classifiers = [
 ]
 
 dependencies = [
-    "ellar >= 0.6.6",
+    "ellar >= 0.6.7",
     "sqlalchemy >= 2.0.23",
     "alembic >= 1.10.0",
     "python-magic >= 0.4.27",

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ classifiers = [`
`32`	`32`	`]`
`33`	`33`
`34`	`34`	`dependencies = [`
`35`		`- "ellar >= 0.6.6",`
	`35`	`+ "ellar >= 0.6.7",`
`36`	`36`	`"sqlalchemy >= 2.0.23",`
`37`	`37`	`"alembic >= 1.10.0",`
`38`	`38`	`"python-magic >= 0.4.27",`