Skip to content

v0.1.1 文件與範例修正 📚

Latest

Choose a tag to compare

@CXPhoenix CXPhoenix released this 29 Jan 15:05

本次更新主要集中於文件完整性與準確性的提升,修正了 Docstring 中的錯誤範例,並為所有模組補上了詳細的使用說明。

✨ 變更重點 (Highlights)

  • 📝 全面補強 Docstrings:為 async_manager 下的所有模組、類別與函式新增了詳細的繁體中文 Docstrings,開發時透過 IDE 查看說明更加方便。
  • 🐛 修正範例錯誤:修復了 Docstring 範例中誤用的函式名稱(如 asynchronization 修正為 to_async),確保複製貼上即可運行。

📋 變更細節 (Changelog)

修正

  • 修正 Docstring 範例中的函式名稱錯誤 (asynchronization -> to_async, managed_limiter -> create_limiter)。
  • 為 async_manager 模組及其子模組補充完整的繁體中文 Docstrings。

文件 (Documentation)

  • 新增 async_manager 模組的完整 Docstrings,包含 AsyncManager 類別、__init__ 與輔助函式。
  • 統一文件中的技術用語,確保無歧義。

📦 安裝指南

使用 uv 或 pip 直接從 GitHub 安裝:

uv add "async-manager @ git+https://github.com/CXPhoenix/async-manager.git@v0.1.1"

或

pip install "git+https://github.com/CXPhoenix/async-manager.git@v0.1.1"

Full Changelog: v0.1.0...v0.1.1