迫使开发人员编写docstring。
django_wtfd的Python项目详细描述
wtfd(编写f*ing文档)是一个django库,它强制开发人员编写docstring。
在Django 1.5.8上开发
安装
- pip安装django_wtfd
- 将django_wtfd添加到项目的已安装应用程序中。
设置
- wtfd_应用程序
- 要包含在docstrings检查中的项目应用程序列表。如果未设置,则将检查项目中的所有.py文件。
- wtfd_strict
- 如果设置为true,则在某些方法/函数/类缺少docstring时,检查将引发异常。默认为false。
用法
要执行docstrings检查,请运行:./manage.py wtfd
注释
- docstrings检查跳过名为“test”的魔术方法、迁移、元类和模块。