编写python代码文档的新方法

archives的Python项目详细描述


归档:编写python代码文档的新方法

imagePyPI versionCode style: blackPython 3.6+ supportedDocumentation style: archives

{/str}是一个新的文档样式 文件本身的linter。它可以帮助您确保 类和函数中的docstring保持最新,并且 充分解释它们的目的、参数和返回值。在

Perhaps the archives are incomplete

特点

  • docstrings的linter(正在工作,但可用!)在
  • (即将推出)文档生成器

使用

安装

pip install archives

运行Linter

^{pr2}$

测试

测试可以用毒物进行!在

# run tests
tox

# only one version of python
tox -e py36

托多

  • 更多规则
  • 多检查规则的更好系统
  • 更多输出格式
  • 可能在desc中进行拼写检查?在
  • 文档生成器
  • 测试

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

推荐PyPI第三方库


热门话题
尝试在graphqljava下使用分析时出现NonNullableFieldWasNullError   键入如何在Java中将LocalDate列表添加到myList   java自定义授权取决于用户属性   java正在读一个。Eclipse中项目中的txt文件   java获取Hibernate Envers中实体的早期版本   java如何创建到枚举类型的映射?   java更改mockito间谍的字段   第一个元素添加到我的通用块列表时出现java空指针异常   使用SFTP和JSch:com的java连接问题。jcraft。jsch。JSchException   序列化Java:序列化对象时,我从我不尝试序列化的类中获取NotSerializableException   Android环境下java高效上传图像到服务器   JAVAlang.IllegalAccessError:尝试访问方法net。sourceforge。tess4j。特塞拉特<来自类Tess4jTest的init>()V。苔丝   java无法连接远程计算机上运行的服务   在名为“dispatcher”的DispatcherServlet中找不到URI为[/ecommerce.mvc/]的HTTP请求的java映射