More docs tweak

Shopify · Oct 2, 2024 · dd772bd · dd772bd
1 parent 2327b0f
commit dd772bd
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 13 deletions.
diff --git a/packages/hydrogen-react/src/optionValueDecoder.decodeEncodedVariant.doc.js b/packages/hydrogen-react/src/optionValueDecoder.decodeEncodedVariant.doc.js
@@ -3,7 +3,6 @@ Object.defineProperty(exports, '__esModule', {value: true});
 const data = {
   name: 'decodeEncodedVariant',
   category: 'utilities',
-  subCategory: 'Product option value decoder',
   isVisualComponent: false,
   related: [
     {

diff --git a/packages/hydrogen-react/src/optionValueDecoder.decodeEncodedVariant.doc.ts b/packages/hydrogen-react/src/optionValueDecoder.decodeEncodedVariant.doc.ts
@@ -3,7 +3,6 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
 const data: ReferenceEntityTemplateSchema = {
   name: 'decodeEncodedVariant',
   category: 'utilities',
-  subCategory: 'Product option value decoder',
   isVisualComponent: false,
   related: [
     {

diff --git a/...ges/hydrogen-react/src/optionValueDecoder.isOptionValueCombinationInEncodedVariant.doc.ts b/...ges/hydrogen-react/src/optionValueDecoder.isOptionValueCombinationInEncodedVariant.doc.ts
@@ -3,7 +3,6 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
 const data: ReferenceEntityTemplateSchema = {
   name: 'isOptionValueCombinationInEncodedVariant',
   category: 'utilities',
-  subCategory: 'Product option value decoder',
   isVisualComponent: false,
   related: [
     {
@@ -32,8 +31,7 @@ const data: ReferenceEntityTemplateSchema = {
     {
       title: 'Props',
       type: 'IsOptionValueCombinationInEncodedVariantForDocs',
-      description:
-        'Determines whether an option value set is present in an encoded option value string.',
+      description: '',
     },
   ],
 };

diff --git a/...hydrogen-react/src/optionValueDecoder.isOptionValueCombinationInEncodedVariant.example.js b/...hydrogen-react/src/optionValueDecoder.isOptionValueCombinationInEncodedVariant.example.js
@@ -42,5 +42,5 @@ isOptionValueCombinationInEncodedVariant([1, 0], encodedVariantExistence); // Re
 isOptionValueCombinationInEncodedVariant([1, 1], encodedVariantExistence); // Return false - no variant exist for [Blue, M]
 isOptionValueCombinationInEncodedVariant([1, 2], encodedVariantExistence); // Return true
 
-// Returns false since there is no entry for the third option
-isOptionValueCombinationInEncodedVariant([2], encodedVariantExistence); // Return false - no variant exist for [Green]
+// Returns false since there is no variant exist for [Green]
+isOptionValueCombinationInEncodedVariant([2], encodedVariantExistence); // Return false
diff --git a/packages/hydrogen-react/src/optionValueDecoder.ts b/packages/hydrogen-react/src/optionValueDecoder.ts
@@ -21,13 +21,9 @@ const V1_CONTROL_CHARS = {
 };
 
 export type IsOptionValueCombinationInEncodedVariantForDocs = (
-  /**
-   * Indices of option values to look up in the encoded option value string. A partial set of indices may be passed to determine whether a node or any children is present. For example, if a product has 3 options, passing [0] will return true if any option value combination for the first option's option value is present in the encoded string.
-   */
+  /* Indices of option values to look up in the encoded option value string. A partial set of indices may be passed to determine whether a node or any children is present. For example, if a product has 3 options, passing [0] will return true if any option value combination for the first option's option value is present in the encoded string. */
   targetOptionValueIndices: number[],
-  /**
-   * Encoded option value string from the Storefront API, e.g. [product.encodedVariantExistence](/docs/api/storefront/2024-10/objects/Product#field-encodedvariantexistence) or [product.encodedVariantAvailability](/docs/api/storefront/2024-10/objects/Product#field-encodedvariantavailability)
-   */
+  /* Encoded option value string from the Storefront API, e.g. [product.encodedVariantExistence](/docs/api/storefront/2024-10/objects/Product#field-encodedvariantexistence) or [product.encodedVariantAvailability](/docs/api/storefront/2024-10/objects/Product#field-encodedvariantavailability) */
   encodedVariantField: string,
 ) => boolean;