The documentation for the bundled gem has not been updated

Aberta
#2,258 3 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
ruby
Domínio
documentation

Direção de pesquisa

Comece pela tarefa de anotação do rake e por como ela reúne a documentação RBS a partir da árvore de código-fonte do ruby/ruby. Revise como as gems incluídas listadas são representadas e decida qual abordagem de documentação deve abrangê-las. Considera-se concluído quando houver uma abordagem acordada e um workflow de documentação atualizado para as gems incluídas.

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

Descrição

The rake annotation task generates documentation for RBS from the ruby/ruby source code. However, bundled gems are not included in the ruby/ruby source code. As a result, the rake annotate task that updates documentation does not update the documentation for bundled gems.

I think we need to decide on how to approach the documentation for bundled gems.

  • minitest
  • net-smtp
  • base64
  • bigdecimal
  • abbrev
  • nkf
  • csv
  • observer
Linguagem predominante
Ruby
Estrelas
2.2k
Forks
263
Merge médio
1d 20h
PRs com merge (30d)
64

Preparar o ambiente

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.

Mais de ruby/rbs

Todas as issues de ruby/rbs

Issues semelhantes

Mais issues de Ruby

Receba novas issues na sua caixa de entrada

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