You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Jan 24, 2024. It is now read-only.
动机
相比于文字描述,示例代码可以更快地让开发者了解到一个 API 是如何使用的,其重要性不言而喻
目前 Paddle 主 repo 已经准备引入 xdoctest,见 中国软件开源创新大赛:飞桨框架任务挑战赛、tracking issue,另外我们 PaddleSOT 合入 Paddle 也还有一段时间,我们可以尽可能使我们的代码风格更加现代,因此这里建议在 PaddleSOT 中增加流水线用于示例代码的检查
目前我已经在 #193 上验证了 xdoctest 的引入可行性,运行如下命令即可检查全部示例代码:
两段示例代码均被正确提取,而且能够检测输出的正确性,
本任务应在 #193 合入后开展,以确保正确性测试(已合入)一些建议
如果有合适的 pre-commit 可以直接集成因为所有版本都要测,还是不要用 pre-commit 了另外可以顺便升级一下 pre-commit 中的 common hooks 的版本,与 PaddlePaddle/Paddle#54796 同步
另外开发相关依赖应该放在
pyproject.toml
中的project.optional-dependencies.dev
使用如下命令安装开发依赖:
pip install -e ".[dev]"
requirements.txt
不再使用,可以移除The text was updated successfully, but these errors were encountered: