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/git/index.ts | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/modules/git')

diff --git a/src/modules/git/index.ts b/src/modules/git/index.ts
index e35ece2b..81e79af0 100644
--- a/src/modules/git/index.ts
+++ b/src/modules/git/index.ts
@@ -21,6 +21,10 @@ const GIT_TIMEZONE_FORMAT = new Intl.NumberFormat('en', {
 
 /**
  * Module to generate git related entries.
+ *
+ * ### Overview
+ *
+ * [`commitEntry()`](https://next.fakerjs.dev/api/git.html#commitentry) generates a random commit entry as printed by `git log`. This includes a commit hash [`commitSha()`](https://next.fakerjs.dev/api/git.html#commitsha), author, date [`commitDate()`](https://next.fakerjs.dev/api/git.html#commitdate), and commit message [`commitMessage()`](https://next.fakerjs.dev/api/git.html#commitmessage). You can also generate a random branch name with [`branch()`](https://next.fakerjs.dev/api/git.html#branch).
  */
 export class GitModule {
   constructor(private readonly faker: Faker) {
-- 
cgit v1.2.3