fix(prettier-plugin-jsdoc): correct typos on the options

homer0 · Oct 31, 2020 · e662134 · e662134
1 parent 791e5e4
commit e662134
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/src/fns/getOptions.js b/src/fns/getOptions.js
@@ -22,14 +22,14 @@ const getOptions = () => ({
     category: 'jsdoc',
     default: false,
     description:
-      'Whether or not to use the @description tag when a description is found in the "body" ' +
+      'Whether or not to use the @description tag when a description is found on the "body" ' +
       'or following a type/callback definition.',
   },
   jsdocFormatExamples: {
     type: 'boolean',
     category: 'jsdoc',
     default: true,
-    description: 'Whether or not to attemp to format the @example tags using Prettier.',
+    description: 'Whether or not to attempt to format the @example tags using Prettier.',
   },
   jsdocLinesBetweenExampleTagAndCode: {
     type: 'int',
@@ -51,7 +51,8 @@ const getOptions = () => ({
     default: false,
     description:
       'Whether or not to add an indentation level to the code snippets of @example tags that ' +
-      'couldn\'t be formatted with Prettier. This is only valid if `jsdocFormatExamples` is `true`',
+      'couldn\'t be formatted with Prettier. This is only valid if `jsdocFormatExamples` is ' +
+      '`true`.',
   },
   jsdocAllowAccessTag: {
     type: 'boolean',
@@ -85,7 +86,7 @@ const getOptions = () => ({
     type: 'int',
     category: 'jsdoc',
     default: 1,
-    description: 'ow many spaces should there be between string literals on a type.',
+    description: 'How many spaces should there be between string literals on a type.',
   },
   jsdocUseTypeScriptTypesCasing: {
     type: 'boolean',
@@ -116,8 +117,8 @@ const getOptions = () => ({
     category: 'jsdoc',
     default: true,
     description:
-      'Whether or not to apply transformations regarding the dot `Array` and `Object` can have ' +
-      'before the their generics (`Array.<...`)',
+      'Whether or not to apply transformations regarding the dot `Array` and `Object` types can ' +
+      'have before their generics (`Array.<...`)',
   },
   jsdocUseDotForArraysAndObjects: {
     type: 'boolean',
@@ -139,7 +140,7 @@ const getOptions = () => ({
     type: 'boolean',
     category: 'jsdoc',
     default: true,
-    description: 'Whether or not to sort the tags of a JSDoc block',
+    description: 'Whether or not to sort the tags of a JSDoc block.',
   },
   jsdocTagsOrder: {
     type: 'path',