Обязательное вводное обучение по форматированию кода?

Внести вклад Функция
1

Привет! Я администратор https://discourse.bokeh.org и часто бываю на https://discuss.python.org. В обоих сообществах есть серьёзная проблема: новые пользователи не оформляют код в своих первых сообщениях. На основном форуме Python такие случаи происходят несколько раз в день, и приходится исправлять ошибки пользователей. [1] Это огромная и постоянная трата времени многих людей.

Возможно ли внедрить обязательный процесс онбординга, прежде чем новый пользователь сможет сделать первое сообщение? Я имею в виду сценарий, где пользователю показывают, как правильно оформлять код, а затем просят вручную воспроизвести 2–3 строки с правильным форматированием. Только после успешного выполнения этого задания пользователь сможет опубликовать сообщение.

  1. Для Python это особенно серьёзная проблема, поскольку отступы имеют значение. ↩︎

2 лайка
What about an "advanced" or "guided" submission process for new topics in certain categories
2

Вы видели Unformatted Code Detector? Это помогло решить ту же проблему в некоторых других сообществах.

3 лайка
3

Да, я бы сказал, что успех был, по большому счёту, ограниченным, по крайней мере на https://discourse.bokeh.org. Но, насколько мне известно, это также было установлено на форуме Python (я там не администратор).

2 лайка
4

Думаю, нет. См. Unformatted Code Detector - #4 by jeanas - Discourse Feedback - Discussions on Python.org — там я не получил никакого предупреждения.

Одним из преимуществ обязательного онбординга могло бы стать выявление скриншотов с кодом, хотя, вероятно, можно было бы использовать OCR для вывода предупреждения в таких постах, аналогично существующему плагину «Unformatted code detector».

Я не знаком с Bokeh, поэтому не могу оценить, насколько хорошо работает этот плагин.

1 лайк
5

На самом деле плагин детектора неформатированного кода включен на discuss.python.org. Я посмотрел категорию «Пользователи» этого форума (я не следил за этой категорией недавно), и, честно говоря, она выглядит гораздо лучше, чем раньше, хотя всё ещё есть несколько постов с неформатированным кодом.

6

Кстати, вот пример от сегодня с большим блоком кода (который должен пройти любой порог), который плагин не перехватил:

Это вызвало побочное обсуждение именно этой темы — онбординг и форматирование кода, и автор оригинального поста (OP) как будто обиделся.

Плагин просто сломан или нуждается в обновлении? В любом случае, я всё ещё считаю, что обязательная задача «отформатируйте этот код» перед возможностью публикации — ценное дополнение к «автоматическому обнаружению».

1 лайк
7

Я только что проверил компонент темы с параметрами по умолчанию и неформатированный код примера — похоже, всё работает.

image
image1920×1080 195 KB

8

Это точно не предотвратило 50+ строк неформатированного кода в связанном посте, который теперь перерос в новые споры. :slight_smile:

9

Может, стоит сделать это чуть более принудительно? :roll_eyes:
Простой первый шаг — немного изменить текст кнопки: возможно, «Отправить» можно заменить на ОСТОРОЖНО!!! или что-то в этом роде…