python文档字符串样式检查器

pydocstyle的Python项目详细描述


https://travis-ci.org/PyCQA/pydocstyle.svg?branch=masterhttps://ci.appveyor.com/api/projects/status/40kkc366bmrrttca/branch/master?svg=trueDocumentation Statushttps://img.shields.io/pypi/pyversions/pydocstyle.svg

pydocstyle是一个静态分析工具,用于检查是否符合python 文档字符串约定。

pydocstyle支持 PEP 257开箱即用,但是 不应视为参考实现。

pydocstyle支持python 3.4、3.5、3.6和3.7。

快速启动

安装

pip install pydocstyle

运行

$ pydocstyle test.py
test.py:18 in private nested class `meta`:
        D101: Docstring missing
test.py:27 in public function `get_user`:
    D300: Use """triple double quotes""" (found '''-quotes)
test:75 in public function `init_database`:
    D201: No blank lines allowed before function docstring (found 1)
...

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

推荐PyPI第三方库


热门话题
异常如何在java中从jar以InputStream的形式加载嵌入式字体?   java如何处理关系0。。1来自uml   java XML解析错误休眠   java如何将数据从一个数据库复制到另一个oracle数据库?   安卓中的java简单选项卡活动   java使用JWT身份验证与用户合作的正确方式是什么?   安卓 Java从队列中检索所有元素,直到队列为空   java Geocoder在Android中经常返回空值   带有删除和添加通知的java自定义arraylist   java是否可以在ingiteRepository中使用“findbyId”方法?   java如何使用ttorrent创建torrent文件?   xml如何从XSL文件中调用Java函数?   java如何模块化长代码   使用节点实现优先级队列时的java nullpointerexception   java My JFrame窗口不会出现   java无法在chrome中运行JavaFXJAR   来自音频文件的java Android基本TTS引擎   java通过传递latlong更新Google地图位置,构造函数抛出空点异常   java如何使用参数创建授权URL请求   java排列数组并将每个结果保存到ArrayList