ruby / ruby/rdoc

RDoc formatter hardcoded to darkfish for RubyGems

Aberta
#653 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
Ruby
Estrelas
930
Forks
465
Merge médio
3d 10h
PRs com merge (30d)
27

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece com a falha relatada na linha 167 de lib/rdoc/generator/darkfish.rb e reproduza-a executando gem rdoc --rdoc --overwrite rake com .gemrc configurado como rdoc: -f horo. Rastreie como a opção de formatter personalizado chega ao RDoc e, em seguida, verifique se gem rdoc aceita o formatter sem o TypeError relatado e usa o formatter solicitado.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
ruby
Domínio
documentation
Tipo de issue
Bug
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.