From b26bdff28ce20fd8d9e264c338c4ead9415dae2c Mon Sep 17 00:00:00 2001 From: xDivisionByZerox Date: Wed, 8 May 2024 12:17:13 +0200 Subject: [PATCH] docs(lorem): define allowed words --- src/definitions/lorem.ts | 3 +++ src/modules/lorem/index.ts | 3 +++ 2 files changed, 6 insertions(+) diff --git a/src/definitions/lorem.ts b/src/definitions/lorem.ts index 88947a87815..5378f4524c6 100644 --- a/src/definitions/lorem.ts +++ b/src/definitions/lorem.ts @@ -2,6 +2,9 @@ import type { LocaleEntry } from './definitions'; /** * The possible definitions related to lorem texts. + * + * The words in this module are determined by the ISO 15924 script of the locale. + * If a locale uses the Latin script, it will utilize Latin lorem words, while a locale using the Cyrillic script will use Cyrillic lorem words, and so forth. */ export type LoremDefinition = LocaleEntry<{ /** diff --git a/src/modules/lorem/index.ts b/src/modules/lorem/index.ts index 1f9ba026327..bbbcbf93974 100644 --- a/src/modules/lorem/index.ts +++ b/src/modules/lorem/index.ts @@ -4,6 +4,9 @@ import { filterWordListByLength } from '../word/filter-word-list-by-length'; /** * Module to generate random texts and words. * + * The words in this module are determined by the script of the locale used in the faker instance. + * If a locale uses the Latin script, it will utilize Latin lorem words, while a locale using the Cyrillic script will use Cyrillic lorem words, and so forth. + * * ### Overview * * Generate dummy content using traditional faux-Latin [lorem ipsum](https://en.wikipedia.org/wiki/Lorem_ipsum) (in other locales to `en`, alternative words may be used).