fix: comments based on review

Author: Victor Wiebe

src/utils/__tests__/utils.ts

@@ -34,10 +34,10 @@ describe('serialize and unserialize', () => {
   });
 });
 
-describe('check string length', () => {
+describe('checkStringLength', () => {
   const testVariableType = 'myVar';
 
-  test('checkStringLength used on a non empty string, catches error above the default 32 characters', () => {
+  test('throws an error when the string length exceeds the 32 character default', () => {
     try {
       checkStringLength('0123456789012345678901234567890123456789', testVariableType);
     } catch (error) {
@@ -50,7 +50,7 @@ describe('check string length', () => {
     }
   });
 
-  test('checkStringLength used on an empty string, catches error due to not meeting custom requirement of 1 - 32 characters', () => {
+  test('throws an error when the string length is lower than the supplied minimum', () => {
     try {
       checkStringLength('', testVariableType, { minLength: 1, maxLength: 32 });
     } catch (error) {
@@ -63,7 +63,7 @@ describe('check string length', () => {
     }
   });
 
-  test('checkStringLength used on a 6 character string, catches error due to not meeting custom requirement of 1 - 5 characters', () => {
+  test('throws an error when the string length is higher than the supplied maximum', () => {
     try {
       checkStringLength('0123456', testVariableType, { minLength: 1, maxLength: 5 });
     } catch (error) {

src/utils/index.ts

@@ -52,6 +52,7 @@ export function areSameAddress(a: string, b: string) {
 
 /**
  * Check the length of a given string to ensure it meets correct bounds
+ *
  * @param value - the string itself
  * @param variableName - the name of the variable associated to the string itself
  * @param opts - optional min and max length of the string. Defaults to a minimum of 0 (empty string) and a maximum of 32 characters