Apply suggestions from code review

Co-authored-by: Łukasz Śliwa <[email protected]>
vuestorefront · Apr 4, 2024 · e5255ad · e5255ad
1 parent 2748e54
commit e5255ad
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 7 deletions.
diff --git a/packages/sdk/src/methods/addBundleProductsToCart/index.ts b/packages/sdk/src/methods/addBundleProductsToCart/index.ts
@@ -13,13 +13,13 @@ export type AddBundleProductsToCart = {
 };
 
 /**
- * Add products to cart response type
+ * Add bundle products to cart response type
  */
 export type AddBundleProductsToCartResponse<T extends DeepPartial<AddBundleProductsToCart> = AddBundleProductsToCart> =
   ApolloQueryResult<T>;
 
 /**
- * Method to add products to cart (returns cart)
+ * Method to add bundle products to cart (returns cart)
  *
  * @remarks
  * This method sends a POST request to the
@@ -42,11 +42,10 @@ export type AddBundleProductsToCartResponse<T extends DeepPartial<AddBundleProdu
  * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/AddProductsToCartResponse | AddProductsToCartResponse}.
  *
  * @example
- * Simple usage:
+ * Adding bundle products to cart with default parameters.
  * ```ts
  * import { sdk } from '~/sdk.config.ts';
  *
- * // add products to cart with default parameters (returns cart)
  * const cart = await sdk.magento.addBundleProductsToCart(
  *   {
  *     cart_id: '123',

diff --git a/packages/sdk/src/methods/addConfigurableProductsToCart/index.ts b/packages/sdk/src/methods/addConfigurableProductsToCart/index.ts
@@ -20,7 +20,7 @@ export type AddConfigurableProductsToCartResponse<
 > = ApolloQueryResult<T>;
 
 /**
- * Method to add products to cart (returns cart)
+ * Method to add configurable products to cart (returns cart)
  *
  * @remarks
  * This method sends a POST request to the
@@ -43,11 +43,10 @@ export type AddConfigurableProductsToCartResponse<
  * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/AddProductsToCartResponse | AddProductsToCartResponse}.
  *
  * @example
- * Simple usage:
+ * Adding configurable products to cart with default parameters.
  * ```ts
  * import { sdk } from '~/sdk.config.ts';
  *
- * // add products to cart with default parameters (returns cart)
  * const cart = await sdk.magento.addConfigurableProductsToCart(
  *   {
  *     cart_id: '123',