python / python/devguide

Test coverage c extension doc fix

Offen
#593 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

topic-test type-bug
Vorherrschende Sprache
Python
Sterne
2.1k
Forks
1k
Ø Merge
2 T. 12 Std.
Gemergte PRs (30 T.)
12

Beschreibung

Currently in the test coverage section, specifically 5.2.1.4, it mentions building the C extension for coverage.py. For a while now coverage.py has come with the C extension by default, so this step is almost never required (see here: https://coverage.readthedocs.io/en/coverage-5.1/install.html#c-extension).
I'm thinking it would be worth mentioning in the guide that installing the C extension is only required if 'coverage --version' says 'Without C extension'.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne im Abschnitt zur Testabdeckung, genauer im Unterabschnitt 5.2.1.4, und vergleiche dessen Anweisung zur C-Erweiterung mit der verlinkten coverage.py-Dokumentation. Erledigt ist die Aufgabe, wenn der Leitfaden erklärt, dass die Installation der Erweiterung nur erforderlich ist, wenn coverage --version „Without C extension“ meldet.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
50/100

Neue Issues direkt in Ihr Postfach

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