End to end testing for `RDoc#generate`

Offen
#1,180 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
48/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
ruby
Bereich
testing

Rechercherichtung

Untersuche zunächst RDoc#generate und die bestehende Teststruktur. Füge End-to-End-Tests für die Dateigenerierung und die Meldung zur Dokumentationsausgabe hinzu, wobei ein isolierter temporärer Ordner verwendet und generierte Dateien nach jedem Testlauf bereinigt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Currently no tests cover RDoc#generate which means we're not testing:

  • The file generation logic
  • The output message of doc generation

To test it right, we need to make sure we generate the documentation in a isolated place (e.g. a temp folder) and the files must be cleaned up after each test run.

Vorherrschende Sprache
Ruby
Sterne
930
Forks
472
Ø Merge
2 T. 8 Std.
Gemergte PRs (30 T.)
12

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 ruby/rdoc

Alle Issues in ruby/rdoc

Ähnliche Issues

Weitere Issues zu Ruby

Neue Issues direkt in Ihr Postfach

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