代码格式化强制入职培训?

您好,我负责运行 https://discourse.bokeh.org,也经常浏览 https://discuss.python.org。在这两个地方,新用户在帖子中不正确地格式化代码是一个相当糟糕的问题。通常每天在主要的 Python 论坛上都有好几个帖子需要纠正用户。[^1] 这对很多人来说是巨大的、持续的时间消耗。

是否有可能在允许新用户发布第一篇帖子之前,强制执行入职流程?我特别想到的是一个流程,向用户展示如何进行代码格式化,然后让他们手动复制 2-3 行格式化的代码。他们必须成功完成此任务才能发布。

[^1]:这对 Python 来说是一个特别有害的问题,因为缩进很重要。

2 个赞

你见过 Unformatted Code Detector 吗?这有助于解决其他社区的相同问题。

3 个赞

充其量可以说它的成功有限,至少在 https://discourse.bokeh.org 上是这样。但据我所知,它也被安装在 Python 论坛上(我不是那里的管理员)。

2 个赞

我不这么认为,请看 Unformatted Code Detector - #4 by jeanas - Discourse Feedback - Discussions on Python.org

强制入职培训可以帮助处理包含代码的截图,尽管 OCR 也可以像现有的“未格式化代码检测器”插件一样,在这些帖子上打印警告。

我不关注 Bokeh,所以我无法判断该插件是否工作良好。

1 个赞

实际上,未格式化代码检测插件discuss.python.org 上启用。我查看了该论坛的用户类别(我最近没有关注这个类别),说实话,它看起来比以前好多了,尽管仍然有一些帖子包含未格式化的代码。

FWIW 这里有一个今天的例子,其中包含一段代码块(应该会通过任何阈值),但插件没有捕获:

这随后引发了一个关于这个入职/代码格式化主题的衍生讨论,OP 似乎对此有些不满。

插件是坏了,还是需要更新?无论如何,我仍然认为在允许发帖之前,强制进行“格式化这段代码”的挑战是“自动检测”的有价值补充。

1 个赞

我刚刚检查了具有默认参数的主题组件和未格式化的示例代码
它似乎在工作

这并没有阻止链接帖子中 50 多行未格式化代码的出现,而此时这已经引发了更多的争议。 :slight_smile:

是否应该更具强制性?也许 :roll_eyes:
一个简单的第一步可能是稍微修改一下按钮的文本,也许“提交”可以改为“注意!!!!”之类的……