RDoc needs a directive to not clobber an overridden method definition's documentation, but add to it.
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 45/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Pouca atividade
- Stack de tecnologia
- ruby
- Domínio
- documentation
Direção de pesquisa
Comece rastreando como o RDoc lida com a documentação de métodos sobrescritos e como as diretivas existentes são representadas. Defina o comportamento da diretiva em torno do exemplo Kernel.require e, em seguida, adicione cobertura mostrando que a documentação original é preservada e que a documentação do método sobrescrevente é anexada em vez de substituí-la.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
RDoc needs a directive to not clobber an overridden method definition's documentation, but add to it.
Use case: I wanted to find out how require worked.
Unfortunately, in RDoc-generated documentation, all I could find is information on how by requiring rubygems the behavior of Kernel.require changed, but nothing about its original behavior.
If RDoc had a directive to add, don't replace documentation, and it was used on the rubygems' monkeypatch of Kernel.require, the original documentation wouldn't have gotten lost.
- Linguagem predominante
- Ruby
- Estrelas
- 928
- Forks
- 471
- Merge médio
- 2d 4min
- PRs com merge (30d)
- 13
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de ruby/rdoc
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 1 dia
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationTalvez já em andamento @OskarEichler assumiu há 65 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
ruby/rdoc#1759 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
markdown html excerpt includes link partsTalvez já em andamento @anyingiit assumiu há 11 dias. Aberta
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 66/100
Mantenedores costumam responder em até 1 dia
-
Regexp generated from unescaped input in #expand_classTalvez já em andamento @jaynetics assumiu há 24 dias. Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 25/100
Mantenedores costumam responder em até 1 dia
Issues semelhantes
-
area/web interface
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
rubys/roundhouse#1757 ·
-
Dificuldade 2/5 Meio dia Facilidade para iniciantes 72/100
shakacode/react-on-rails-demo-flagship#102 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
akitaonrails/ai-book-2026#12 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
openfoodfoundation/openfoodnetwork#14970 ·
Mantenedores costumam responder em até 1 dia