Zxc200611/pocketpy
1
0
Fork 0
mirror of https://github.com/pocketpy/pocketpy synced 2025-10-20 19:40:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

add lz4 module doc

Browse Source
This commit is contained in:
blueloveTH 2024-12-14 00:19:56 +08:00
parent 61acaeafd3
commit 24d6b96f91
3 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/modules/gc.md
View File

@ -3,7 +3,6 @@ icon: package
label: gc label: gc
--- ---
### `gc.collect()` ### `gc.collect()`
Invoke the garbage collector. Invoke the garbage collector.

14
docs/modules/lz4.md Normal file
View File

@ -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" :::

2
include/typings/lz4.pyi
View File

@ -5,7 +5,7 @@ def compress(data: bytes) -> bytes:
""" """
def decompress(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/. This function is equivalent to `lz4.block.decompress` of https://pypi.org/project/lz4/.
""" """