ruby / ruby/rdoc

RDoc formatter hardcoded to darkfish for RubyGems

Ouverte
#653 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Ruby
Étoiles
930
Forks
465
Merge moyen
3 j 10 h
PR mergées (30 j)
27

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par l'échec signalé à la ligne 167 de lib/rdoc/generator/darkfish.rb et reproduisez-le en exécutant gem rdoc --rdoc --overwrite rake avec .gemrc configuré comme rdoc: -f horo. Suivez le cheminement de l'option du formatter personnalisé jusqu'à RDoc, puis vérifiez que gem rdoc accepte le formatter sans le TypeError signalé et utilise le formatter demandé.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
ruby
Domaine
documentation
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.