Update for Carpentries Style

Offen Anfängerfreundlich
#179 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

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

Rechercherichtung

Lies den gesamten Unterrichtsinhalt durch und konzentriere dich dabei auf Vorkommen von „OK!“, „interesting“, „significant“, Kursivschrift in Episode 10 und Kurzformen wie „let’s“ und „don’t“. Überarbeite Formulierungen und Formatierung, um die Stilprüfung zu berücksichtigen, und prüfe anschließend, ob dies im gesamten Unterricht einheitlich umgesetzt wurde; das Issue nennt keine konkreten Dateien oder Tests.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

good first issue
How could the content be improved?

Via Carpentries Lab review:

I felt that the use of "OK!" and "This is interesting, ..." to be a bit more colloquialisms and geared towards audiences whose native language is English, especially with the OK. I would remove the use of interesting and significant as that implies a judgement made by the writers and not those doing the lesson who might find something else interesting or significant.

Encapsulate in italics seems a little strange. I would remove the italic (episode 10).

There are contractions used throughout such as let's, don't, or doesn't.

Vorherrschende Sprache
HTML
Sterne
25
Forks
65
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus LibraryCarpentry/lc-python-intro

Alle Issues in LibraryCarpentry/lc-python-intro

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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