在文档代码段上涂黑
blackdoc的Python项目详细描述
blackdoc是一个将black应用于文档中的代码的工具。在
它最初是对gist的重写并调用 black doctest。2020年4月,它被重命名为blackdoc。在
使用
命令行接口支持两种模式:检查和就地 重新格式化。在
^{pr2}$在就地重新格式化模式下,它将重新格式化doctest行和 将它们写回磁盘:
# on explicitly mentioned files python -m blackdoc file1.py file2.py # on the whole directory python -m blackdoc .
检查时,它将报告更改的文件,但不会将其写入磁盘:
python -m blackdoc --check .
也可以使用入口点脚本:
blackdoc --help
- 项目
标签: