From 2d41dd4c789314a16a81ce2a103c2f868fe90c6c Mon Sep 17 00:00:00 2001
From: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
Date: Mon, 30 Jan 2023 15:12:55 -0700
Subject: [PATCH] adjust comment

---
 types.ts | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/types.ts b/types.ts
index 23cd071..0677ac7 100644
--- a/types.ts
+++ b/types.ts
@@ -220,7 +220,7 @@ export type WithNullable<T> = T & {
 export type DefaultString =
   | string
   | {
-    /** The chars available for the randome generation */
+    /** The chars available for the random generation */
     charset?: string;
     /** Length that we generate to */
     len: number;
@@ -318,8 +318,10 @@ export type ValueSpecUnion = {
   /** What tag for the specification, for tag unions */
   tag: {
     id: string;
-    name?: string; // optional for backwards compatibility - removed in 0.3.4
-    description?: string; // optional for backwards compatibility - removed in 0.3.4
+    /** @deprecated - optional only for backwards compatibility */
+    name?: string;
+    /** @deprecated - optional only for backwards compatibility */
+    description?: string;
     "variant-names": {
       [key: string]: string;
     };