Obligatorisches Onboarding-Training für Codeformatierung?

Hallo, ich betreibe https://discourse.bokeh.org und besuche auch oft https://discuss.python.org. An beiden Orten gibt es ein ziemlich schlimmes Problem damit, dass neue Benutzer Code in ihren ersten Beiträgen nicht formatieren. Es gibt typischerweise mehrere Beiträge pro Tag im Hauptforum für Python, bei denen Benutzer korrigiert werden müssen. [1] Dies ist eine enorme, ständige Belastung für die Zeit vieler Menschen.

Wäre es möglich, obligatorische Onboarding-Flows einzuführen, bevor ein neuer Benutzer seinen ersten Beitrag veröffentlichen darf? Ich denke dabei insbesondere an einen Flow, bei dem dem Benutzer gezeigt wird, wie man Code formatiert, und der Benutzer dann aufgefordert wird, 2-3 Zeilen formatierten Code manuell zu reproduzieren. Er muss dies erfolgreich abschließen, bevor er posten darf.


  1. Dies ist ein besonders heimtückisches Problem für Python, da die Einrückung von Bedeutung ist. ↩︎

2 „Gefällt mir“

Haben Sie Unformatted Code Detector gesehen? Dies hat bei demselben Problem in einigen anderen Communities geholfen.

3 „Gefällt mir“

Ja, ich würde sagen, dass es bestenfalls begrenzte Erfolge hatte, zumindest auf https://discourse.bokeh.org. Aber meines Wissens wurde es auch im Python-Forum installiert (ich bin dort kein Administrator).

2 „Gefällt mir“

Ich glaube nicht, siehe Unformatted Code Detector - #4 by jeanas - Discourse Feedback - Discussions on Python.org, wofür ich keine Warnung erhalten habe.

Eine Sache, bei der ein obligatorisches Onboarding helfen würde, sind Screenshots mit Code darin, obwohl OCR vermutlich verwendet werden könnte, um solche Beiträge wie das vorhandene Plugin “Unformatted Code Detector” zu warnen.

Ich verfolge Bokeh nicht, daher kann ich nicht beurteilen, ob das Plugin gut funktioniert oder nicht.

1 „Gefällt mir“

Tatsächlich ist das Plugin zur Erkennung von unformatiertem Code auf discuss.python.org aktiviert. Ich habe mir die Kategorie „Benutzer“ dieses Forums angesehen (ich habe diese Kategorie in letzter Zeit nicht verfolgt) und fairerweise muss ich sagen, dass sie viel besser aussieht als früher, obwohl es immer noch ein paar Beiträge mit unformatiertem Code gibt.

Hier ist ein Beispiel von heute, bei dem ein großer Codeblock (der jede Schwelle überschreiten sollte) vom Plugin nicht erkannt wurde:

Dies führte zu einer Folge-Diskussion genau über dieses Thema der Onboarding-/Code-Formatierung, was den OP anscheinend etwas verärgerte.

Ist das Plugin einfach kaputt oder muss es aktualisiert werden? Unabhängig davon bin ich immer noch der Meinung, dass eine obligatorische “Formatieren Sie diesen Code”-Herausforderung, bevor das Posten erlaubt ist, eine wertvolle Ergänzung zur “automatischen Erkennung” ist.

1 „Gefällt mir“

Ich habe gerade die Theme-Komponente mit ihren Standardparametern und dem unformatierten Code des Beispiels überprüft.
Sie scheint zu funktionieren.

Es hat auf keinen Fall die über 50 Zeilen unformatierten Codes im verlinkten Beitrag verhindert, was zu diesem Zeitpunkt zu noch mehr Streit geführt hat. :slight_smile:

sollte es etwas zwingender sein? vielleicht :roll_eyes:
Ein einfacher erster Schritt könnte eine kleine Änderung des Textes des Buttons sein, vielleicht könnte submit
ACHTUNG !!!
oder so ähnlich sein…