RDoc formatter hardcoded to darkfish for RubyGems
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Ruby
- Sterne
- 930
- Forks
- 465
- Ø Merge
- 3 T. 10 Std.
- Gemergte PRs (30 T.)
- 27
Beschreibung
It seems that RDoc is not currently designed to allow a custom formatter when running gem rdoc. Even when using .gemrc and setting the --format option to a custom formatter (like horo) seems to not work. In fact, in the latest version of RDoc (6.0.4), any attempt to use a custom formatter via .gemrc causes a crash:
$ gem rdoc --rdoc --overwrite rake
Parsing documentation for rake-12.3.1
Installing ri documentation for rake-12.3.1
ERROR: While executing gem ... (TypeError)
no implicit conversion of nil into String
My .gemrc file:
rdoc: -f horo
I traced the TypeError exception to here: https://github.com/ruby/rdoc/blob/master/lib/rdoc/generator/darkfish.rb#L167
Thanks in advance.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem in lib/rdoc/generator/darkfish.rb in Zeile 167 gemeldeten Fehler und reproduziere ihn, indem du gem rdoc --rdoc --overwrite rake ausführst, wobei .gemrc mit rdoc: -f horo konfiguriert ist. Verfolge, wie die Option für den benutzerdefinierten Formatter RDoc erreicht, und überprüfe anschließend, dass gem rdoc den Formatter ohne den gemeldeten TypeError akzeptiert und den angeforderten Formatter verwendet.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- ruby
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100