From 24d6b96f918e22fa5207e25e357526f65abcb063 Mon Sep 17 00:00:00 2001
From: blueloveTH <blueloveth@foxmail.com>
Date: Sat, 14 Dec 2024 00:19:56 +0800
Subject: [PATCH] add `lz4` module doc

---
 docs/modules/gc.md      |  1 -
 docs/modules/lz4.md     | 14 ++++++++++++++
 include/typings/lz4.pyi |  2 +-
 3 files changed, 15 insertions(+), 2 deletions(-)
 create mode 100644 docs/modules/lz4.md

diff --git a/docs/modules/gc.md b/docs/modules/gc.md
index 8fe96469..4e773cbb 100644
--- a/docs/modules/gc.md
+++ b/docs/modules/gc.md
@@ -3,7 +3,6 @@ icon: package
 label: gc
 ---
 
-
 ### `gc.collect()`
 
 Invoke the garbage collector.
\ No newline at end of file
diff --git a/docs/modules/lz4.md b/docs/modules/lz4.md
new file mode 100644
index 00000000..bfaa4da5
--- /dev/null
+++ b/docs/modules/lz4.md
@@ -0,0 +1,14 @@
+---
+icon: package
+label: lz4
+---
+
+!!!
+This module is optional. Set option `PK_BUILD_MODULE_LZ4` to `ON` in your `CMakeLists.txt` to enable it.
+!!!
+
+LZ4 compression and decompression.
+
+#### Source code
+
+:::code source="../../include/typings/lz4.pyi" :::
diff --git a/include/typings/lz4.pyi b/include/typings/lz4.pyi
index 23fc43d9..c897bdfc 100644
--- a/include/typings/lz4.pyi
+++ b/include/typings/lz4.pyi
@@ -5,7 +5,7 @@ def compress(data: bytes) -> bytes:
     """
 
 def decompress(data: bytes) -> bytes:
-    """Decompress the given LZ4 block format data produced by lz4.compress().
+    """Decompress the given LZ4 block format data produced by `lz4.compress()`.
     
     This function is equivalent to `lz4.block.decompress` of https://pypi.org/project/lz4/.
     """