clearify docstring and fix syntax

viur-framework · Feb 14, 2025 · 4aa4182 · 4aa4182
1 parent 385ef3d
commit 4aa4182
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/src/viur/shop/modules/cart.py b/src/viur/shop/modules/cart.py
@@ -556,12 +556,12 @@ def additional_add_or_update_article(
         This method can be overridden in a subclass to implement additional API fields or
         make further modifications to the cart skeleton (`skel`).
         By default, it raises an exception if unexpected arguments
-        (``kwargs``) are provided and returns the unchanged `skel`` object.
+        (``kwargs``) are provided and returns the unchanged `skel` object.
 
-        :param skel: The current instance of the cart skeleton.
+        :param skel: The current instance of the cart item skeleton.
         :param kwargs: Additional optional arguments for extended implementations.
         :raises TooManyArgumentsException: If unexpected arguments are passed in ``kwargs``.
-        :return: The (potentially modified) cart skeleton.
+        :return: The (potentially modified) cart item skeleton.
         """
         if kwargs:
             raise e.TooManyArgumentsException(f"{self}.add_or_update_article", *kwargs.keys())
@@ -579,7 +579,7 @@ def additional_cart_add(
         This method can be overridden in a subclass to implement additional API fields or
         make further modifications to the cart skeleton (`skel`).
         By default, it raises an exception if unexpected arguments
-        (``kwargs``) are provided and returns the unchanged `skel`` object.
+        (``kwargs``) are provided and returns the unchanged `skel` object.
 
         :param skel: The current instance of the cart skeleton.
         :param kwargs: Additional optional arguments for extended implementations.
@@ -602,7 +602,7 @@ def additional_cart_update(
         This method can be overridden in a subclass to implement additional API fields or
         make further modifications to the cart skeleton (`skel`).
         By default, it raises an exception if unexpected arguments
-        (``kwargs``) are provided and returns the unchanged `skel`` object.
+        (``kwargs``) are provided and returns the unchanged `skel` object.
 
         :param skel: The current instance of the cart skeleton.
         :param kwargs: Additional optional arguments for extended implementations.

diff --git a/src/viur/shop/modules/order.py b/src/viur/shop/modules/order.py
@@ -520,7 +520,7 @@ def additional_order_add(
         This method can be overridden in a subclass to implement additional API fields or
         make further modifications to the order skeleton (`skel`).
         By default, it raises an exception if unexpected arguments
-        (``kwargs``) are provided and returns the unchanged `skel`` object.
+        (``kwargs``) are provided and returns the unchanged `skel` object.
 
         :param skel: The current instance of the order skeleton.
         :param kwargs: Additional optional arguments for extended implementations.
@@ -543,7 +543,7 @@ def additional_order_update(
         This method can be overridden in a subclass to implement additional API fields or
         make further modifications to the order skeleton (`skel`).
         By default, it raises an exception if unexpected arguments
-        (``kwargs``) are provided and returns the unchanged `skel`` object.
+        (``kwargs``) are provided and returns the unchanged `skel` object.
 
         :param skel: The current instance of the order skeleton.
         :param kwargs: Additional optional arguments for extended implementations.