迫使开发人员编写docstring。

django_wtfd的Python项目详细描述


wtfd(编写f*ing文档)是一个django库,它强制开发人员编写docstring。

在Django 1.5.8上开发

安装

  1. pip安装django_wtfd
  2. 将django_wtfd添加到项目的已安装应用程序中。

设置

wtfd_应用程序
要包含在docstrings检查中的项目应用程序列表。如果未设置,则将检查项目中的所有.py文件。
wtfd_strict
如果设置为true,则在某些方法/函数/类缺少docstring时,检查将引发异常。默认为false。

用法

要执行docstrings检查,请运行:./manage.py wtfd

注释

  • docstrings检查跳过名为“test”的魔术方法、迁移、元类和模块。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java Jsonify使用Jackson来定义嵌套对象   在Swing中禁用java图形调试   java Selenium Webdriver拖放在Jenkins上不起作用   java我对一个显示器的问题有一个非常不切实际的询问   java增强的“for”循环导致ArrayIndexOutOfBoundsException   ArrayAdapter适用于Java中的安卓编程,字符串数组   linux在Ubuntu上通过PulseAudio播放Java音频文件时出错   java在Spring应用程序中加载内部(类路径)和外部属性文件   java使用Maven连接到mySQL   Java应用程序的设计   websocket在电报api java中与dc的连接   java XMLStreamException,因为xml中的(&N)   java从控制台输出到JTextArea   Java导出文本文件   java实现parseInt方法   java为什么servlet容器会同步对特定资源/servlet的多个请求的访问?   循环中的Java“while”变量   用Java编程一个国际象棋游戏,gameOver布尔不起作用   java如何获得真正的JPanel大小?