参数、返回和引发的内联文档
项目描述
西格多克
参数、返回和引发的内联文档。
在文档字符串中记录函数参数和返回是乏味的 - 类型提示需要重复，顺序难以维护，添加/删除的参数和返回很容易不同步。
sigdoc通过注释函数的参数和返回类型提示“内联”，提供帮助器在运行时自动扩展文档字符串。这种内联符号极大地增加了代码和文档的局部性，减少了维护负担。
由于这依赖于运行时生成，因此完整的文档字符串仅对运行时检查可见。幸运的是，这包括help(...)在python、ipython和jupyter（包括Shift+Tab）中。静态分析工具（例如许多 IDE）不知道如何破译完整的文档字符串，但通常会显示函数的签名，其中仍然包含所有有用的信息。
安装
sigdoc可以从 python 3.9+ 上的 PyPI 安装，带有pip install sigdoc.
贡献
欢迎大家贡献 - 随时打开问题或 PR！
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
sigdoc-0.0.1.tar.gz
（6.0 kB
查看哈希）
内置分布
sigdoc-0.0.1-py3-none-any.whl
（5.8 kB
查看哈希）