google / google/codeworld

Teacher-targeted documentation

Offen
#1,254 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
Haskell
Sterne
1.3k
Forks
201
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Many of the teacher-facing features of CodeWorld are not well documented. This includes:

1. The requirements checker, useful for additional feedback.
2. Import by hash, useful for designed exercises with domain-specific framework or scaffolding.
3. The CodeWorld.Image module, useful for more easily importing educational assets.
4. The CodeWorld.Parameter module (#1243), useful for easy interactive student exploration.
5. Clipping (useful for incorporating student images into bigger context without overflow).
6. Prelude replacements, when available (#1245)
7. Embeddable environments, when available (#1248)

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Das Issue nennt keine Dokumentationsdateien oder Tests. Beginne damit, die lehrkraftorientierte Dokumentation zu finden und den requirements checker, import by hash, CodeWorld.Image, CodeWorld.Parameter, clipping, Prelude replacements und embeddable environments zu überprüfen, einschließlich der Referenzen #1243, #1245 und #1248. Erledigt ist die Aufgabe, wenn jedes verfügbare Feature eine klare, lehrkraftorientierte Dokumentation hat und nicht verfügbare Features identifiziert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
haskell
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.