carpentries-incubator / carpentries-incubator/python-intermediate-development

Common Issues, Fixes & Tips is not very accessible.

Offen
#490 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TeX
Sterne
63
Forks
77
Ø Merge
20 Std. 8 Min.
Gemergte PRs (30 T.)
3

Beschreibung

Possibly relating to #470: The issues and fixes are a bit obscure thanks to being hidden away.
They are referred to where relevant, but e.g. [here](https://carpentries-incubator.github.io/python-intermediate-development/12-virtual-environments.html#making-sure-you-can-invoke-python) it's at the end of a wordy sentence.

It could potentially be foregrounded more by having the Prerequisite just be the "What you need to be able to do", followed by another large "Common Issues" callout that says (more concisely) "If [problem], check the Common Fixes page" and links to it. Shifting the description of the fix to the fixes section would save enough space that it wouldn't take any extra.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit dem verlinkten Abschnitt "Making sure you can invoke Python" und finde die vorhandenen Verweise auf die Seiten Common Issues und Common Fixes. Überprüfe, wie die Anleitung zu Voraussetzungen und Problemen präsentiert wird, und mache dann die häufigen Probleme mit prägnanten Links auffälliger; fertig ist die Aufgabe, wenn Lernende die Lösungen finden können, ohne einen umständlichen Satz analysieren zu müssen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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