Inconsistent extra blank line after function docstring?

未关闭
#345 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
48/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
冷清
技术栈
python
领域
tooling

调研方向

使用 docformatter==1.7.8、issue 中的配置以及 weaver/execute.py 中链接的两个部分,复现所报告的格式。比较当 blank = False 时,formatter 如何处理每个函数 docstring 后的额外空行;完成的标准是该行为与文档说明的设置一致,并由回归测试覆盖。

由索引模型根据 Issue 内容生成。

描述

C: convention P: bug U: high

Using docformatter==1.7.8, I now get the following diff using the below config.

I'm not sure what is happening. I would expect them to both have the extra line or not based on blank value, but not have a mix of them.

[docformatter]
recursive = true
wrap-descriptions = 0
wrap-summaries = 120
make-summary-multi-line = True
pre-summary-newline = True
blank = False

https://github.com/crim-ca/weaver/blob/13714bfc6e4093ca91e04fa6153c91677ede6e6c/weaver/execute.py#L265-L266

Image

https://github.com/crim-ca/weaver/blob/13714bfc6e4093ca91e04fa6153c91677ede6e6c/weaver/execute.py#L176-L178

Image

主要语言
Python
星标
598
派生
98
平均合并
1 天 7 小时
30 天内合并 PR
17

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

PyCQA/docformatter 的其他 Issue

查看 PyCQA/docformatter 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。