vscode 在签名中软换行长行时,使用缩进而不是取消缩进,

rggaifut  于 5个月前  发布在  Vscode
关注(0)|答案(2)|浏览(59)

问题

如果函数签名包含长行,VScode帮助弹出窗口/检查器会将该行折行并取消缩进。如果折行后的行相对于原始行进行缩进(就像Python代码中的缩进一样,用于表示属于前一行/缩进级别),那么阅读起来会更容易。以下是来自Altair文档的示例;您可以看到不同的参数如何融合在一起,由于缩进处理方式的不同,很难判断哪个选项属于哪个参数:

文档字符串难以阅读还有其他原因,我们正在努力解决这些问题,但折行的方式是其中之一。

建议解决方案

将折行的行相对于参数名的缩进多缩进一个级别。我认为这将显著提高可读性,例如上面的截图所示:

这也是在文档字符串中处理折行的方式,因此将其以这种方式处理签名也会保持一致。

vc6uscn9

vc6uscn91#

这也是文档字符串格式化部分的问题,而不仅仅是初始函数签名:

如果 namesheaderindex_col 是左边最深的缩进级别上唯一的单词,并且所有其他文本都缩进了,而不是紧跟在这些单词后面的句子,那么阅读起来会容易得多。
@aiday-mar 我注意到你被分配到这个问题了,你知道这个修复会是什么样子吗?只是在一个文件中修改css还是更复杂一些?

juzqafwq

juzqafwq2#

Hi @joelostblom thanks for posting this issue. I believe the fix would be more involved as it would involve adding increasingly more tabulations at the beginning of the line breaks. This is currently not on the iteration plan for this milestone, so if this is an urgent issue, you may have a go at implementing this.

相关问题