aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorShinigami <[email protected]>2024-06-22 11:18:58 +0200
committerGitHub <[email protected]>2024-06-22 11:18:58 +0200
commit05237e42ba25ef27af162b00b12115b74a99afe1 (patch)
tree415988cd802fe242ca85a6076250428217e4fccf /src
parentff2dae48be1713db49e7d651529562a4c84a70e9 (diff)
downloadfaker-05237e42ba25ef27af162b00b12115b74a99afe1.tar.xz
faker-05237e42ba25ef27af162b00b12115b74a99afe1.zip
docs: simplify word description sentences (#2963)
Co-authored-by: Matt Mayer <[email protected]>
Diffstat (limited to 'src')
-rw-r--r--src/modules/word/index.ts18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/modules/word/index.ts b/src/modules/word/index.ts
index 0408f3cf..ce46210b 100644
--- a/src/modules/word/index.ts
+++ b/src/modules/word/index.ts
@@ -7,7 +7,7 @@ import { filterWordListByLength } from './filter-word-list-by-length';
*/
export class WordModule extends ModuleBase {
/**
- * Returns an adjective of random or optionally specified length.
+ * Returns a random adjective.
*
* @param options The expected length of the word or the options to use.
* @param options.length The expected length of the word.
@@ -77,7 +77,7 @@ export class WordModule extends ModuleBase {
}
/**
- * Returns an adverb of random or optionally specified length.
+ * Returns a random adverb.
*
* @param options The expected length of the word or the options to use.
* @param options.length The expected length of the word.
@@ -147,7 +147,7 @@ export class WordModule extends ModuleBase {
}
/**
- * Returns a conjunction of random or optionally specified length.
+ * Returns a random conjunction.
*
* @param options The expected length of the word or the options to use.
* @param options.length The expected length of the word.
@@ -217,7 +217,7 @@ export class WordModule extends ModuleBase {
}
/**
- * Returns an interjection of random or optionally specified length.
+ * Returns a random interjection.
*
* @param options The expected length of the word or the options to use.
* @param options.length The expected length of the word.
@@ -287,7 +287,7 @@ export class WordModule extends ModuleBase {
}
/**
- * Returns a noun of random or optionally specified length.
+ * Returns a random noun.
*
* @param options The expected length of the word or the options to use.
* @param options.length The expected length of the word.
@@ -357,7 +357,7 @@ export class WordModule extends ModuleBase {
}
/**
- * Returns a preposition of random or optionally specified length.
+ * Returns a random preposition.
*
* @param options The expected length of the word or the options to use.
* @param options.length The expected length of the word.
@@ -427,7 +427,7 @@ export class WordModule extends ModuleBase {
}
/**
- * Returns a verb of random or optionally specified length.
+ * Returns a random verb.
*
* @param options The expected length of the word or the options to use.
* @param options.length The expected length of the word.
@@ -497,7 +497,7 @@ export class WordModule extends ModuleBase {
}
/**
- * Returns a random sample of random or optionally specified length.
+ * Returns a random word, that can be an adjective, adverb, conjunction, interjection, noun, preposition, or verb.
*
* @param options The expected length of the word or the options to use.
* @param options.length The expected length of the word.
@@ -579,7 +579,7 @@ export class WordModule extends ModuleBase {
}
/**
- * Returns a string containing a number of space separated random words.
+ * Returns a random string containing some words separated by spaces.
*
* @param options The optional options object or the number of words to return.
* @param options.count The number of words to return. Defaults to a random value between `1` and `3`.