Merge pull request #3643 from hey-api/refactor/docs-eg

Refactor/docs eg

Author: mrlubos

docs/openapi-ts/integrations.md

@@ -295,7 +295,7 @@ export const mergeHeaders = (
             mergedHeaders = mergedHeaders.append(key, v as string);
           }
         } else if (value !== undefined) {
-          // assume object headers are meant to be JSON stringified, i.e. their
+          // assume object headers are meant to be JSON stringified, i.e., their
           // content value in OpenAPI specification is 'application/json'
           mergedHeaders = mergedHeaders.set(
             key,

examples/openapi-ts-angular-common/src/client/client/utils.gen.ts

@@ -80,7 +80,7 @@ export interface Config {
   requestValidator?: (data: unknown) => Promise<unknown>;
   /**
    * A function transforming response data before it's returned. This is useful
-   * for post-processing data, e.g. converting ISO strings into Date objects.
+   * for post-processing data, e.g., converting ISO strings into Date objects.
    */
   responseTransformer?: (data: unknown) => Promise<unknown>;
   /**

examples/openapi-ts-angular-common/src/client/core/types.gen.ts

@@ -126,7 +126,7 @@ export function getValidRequestBody(options: {
       return hasSerializedBody ? options.serializedBody : null;
     }
 
-    // not all clients implement a serializedBody property (i.e. client-axios)
+    // not all clients implement a serializedBody property (i.e., client-axios)
     return options.body !== '' ? options.body : null;
   }
 

examples/openapi-ts-angular-common/src/client/core/utils.gen.ts

@@ -295,7 +295,7 @@ export const mergeHeaders = (
             mergedHeaders = mergedHeaders.append(key, v as string);
           }
         } else if (value !== undefined) {
-          // assume object headers are meant to be JSON stringified, i.e. their
+          // assume object headers are meant to be JSON stringified, i.e., their
           // content value in OpenAPI specification is 'application/json'
           mergedHeaders = mergedHeaders.set(
             key,

examples/openapi-ts-angular/src/client/client/utils.gen.ts

@@ -80,7 +80,7 @@ export interface Config {
   requestValidator?: (data: unknown) => Promise<unknown>;
   /**
    * A function transforming response data before it's returned. This is useful
-   * for post-processing data, e.g. converting ISO strings into Date objects.
+   * for post-processing data, e.g., converting ISO strings into Date objects.
    */
   responseTransformer?: (data: unknown) => Promise<unknown>;
   /**

examples/openapi-ts-angular/src/client/core/types.gen.ts

@@ -126,7 +126,7 @@ export function getValidRequestBody(options: {
       return hasSerializedBody ? options.serializedBody : null;
     }
 
-    // not all clients implement a serializedBody property (i.e. client-axios)
+    // not all clients implement a serializedBody property (i.e., client-axios)
     return options.body !== '' ? options.body : null;
   }
 

examples/openapi-ts-angular/src/client/core/utils.gen.ts

@@ -192,7 +192,7 @@ export const mergeHeaders = (
           mergedHeaders[key] = [...(mergedHeaders[key] ?? []), v as string];
         }
       } else if (value !== undefined) {
-        // assume object headers are meant to be JSON stringified, i.e. their
+        // assume object headers are meant to be JSON stringified, i.e., their
         // content value in OpenAPI specification is 'application/json'
         mergedHeaders[key] = typeof value === 'object' ? JSON.stringify(value) : (value as string);
       }

examples/openapi-ts-axios/src/client/client/utils.gen.ts

@@ -80,7 +80,7 @@ export interface Config {
   requestValidator?: (data: unknown) => Promise<unknown>;
   /**
    * A function transforming response data before it's returned. This is useful
-   * for post-processing data, e.g. converting ISO strings into Date objects.
+   * for post-processing data, e.g., converting ISO strings into Date objects.
    */
   responseTransformer?: (data: unknown) => Promise<unknown>;
   /**

examples/openapi-ts-axios/src/client/core/types.gen.ts

@@ -126,7 +126,7 @@ export function getValidRequestBody(options: {
       return hasSerializedBody ? options.serializedBody : null;
     }
 
-    // not all clients implement a serializedBody property (i.e. client-axios)
+    // not all clients implement a serializedBody property (i.e., client-axios)
     return options.body !== '' ? options.body : null;
   }