From 3562e872530b3610d95be71aa6f4f7fdfef7134f Mon Sep 17 00:00:00 2001
From: Matt Mayer <152770+matthewmayer@users.noreply.github.com>
Date: Wed, 29 Mar 2023 20:36:46 +0700
Subject: docs: add overview guides to specific modules (#1929)

---
 src/modules/lorem/index.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/modules/lorem')

diff --git a/src/modules/lorem/index.ts b/src/modules/lorem/index.ts
index 4e124929..fb633a0d 100644
--- a/src/modules/lorem/index.ts
+++ b/src/modules/lorem/index.ts
@@ -3,6 +3,14 @@ import { filterWordListByLength } from '../word/filterWordListByLength';
 
 /**
  * Module to generate random texts and words.
+ *
+ * ### 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).
+ *
+ * In order of increasing size you can generate a single [`word()`](https://next.fakerjs.dev/api/lorem.html#word), multiple [`words()`](https://next.fakerjs.dev/api/lorem.html#words), a [`sentence()`](https://next.fakerjs.dev/api/lorem.html#sentence), multiple [`sentences()`](https://next.fakerjs.dev/api/lorem.html#sentences), [`lines()`](https://next.fakerjs.dev/api/lorem.html#lines) separated by newlines, one [`paragraph()`](https://next.fakerjs.dev/api/lorem.html#paragraph), or multiple [`paragraphs()`](https://next.fakerjs.dev/api/lorem.html#paragraphs).
+ *
+ * The generic [`text()`](https://next.fakerjs.dev/api/lorem.html#text) method can be used to generate some text between one sentence and multiple paragraphs, while [`slug()`](https://next.fakerjs.dev/api/lorem.html#slug) generates an URL-friendly hyphenated string.
  */
 export class LoremModule {
   constructor(private readonly faker: Faker) {
-- 
cgit v1.2.3