Documenting `Data` classes
Mantenedores costumam responder em até 1 dia
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 45/100
- Tipo de issue
- Bug
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- ruby
- Domínio
- documentation
Direção de pesquisa
Comece reproduzindo os exemplos documentados com rdoc, com e sem o parser Prism, para Data.define, Struct.new e a reabertura da classe gerada. Rastreie como essas definições são classificadas e verifique se a classe e seus métodos são documentados como uma classe, enquanto a documentação obsoleta de Object não é mantida.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
rdoc does not usefully document data classes defined the correct way:
# Documenting a class made with Data.define
MyDataClass = Data.define :a do
# Capitalize the value of +a+.
def cap
a.capitalize
end
end
This documents a constant on Object, Object::MyDataClass instead of documenting it as a class itself, and the method within the data class definition is not documented either. It does not matter whether the Prism parser is used.
When documented with reopening, there are two different issues
MyDataClass = Data.define :a # :nodoc:
# Documenting a class made with Data.define
class MyDataClass
# Capitalize the value of +a+.
def cap
a.capitalize
end
end
If defined without # :nodoc:, MyDataClass is still documented as a constant on Object; if defined with # :nodoc:, the documentation is removed, but the generated documentation pages for Object isn't removed.
I believe that Data.define and Struct.new should be treated as if they were written as class variants.
- Linguagem predominante
- Ruby
- Estrelas
- 928
- Forks
- 469
- Merge médio
- 1d 7h
- PRs com merge (30d)
- 17
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
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationTalvez já em andamento @OskarEichler assumiu há 48 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
-
Regexp generated from unescaped input in #expand_classTalvez já em andamento @jaynetics assumiu há 7 dias. Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 25/100
Mantenedores costumam responder em até 1 dia
-
enhancement
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 68/100
ruby/rdoc#1823 · 5 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
Mantenedores costumam responder em até 1 dia
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
thewca/worldcubeassociation.org#16088 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 66/100
Mantenedores costumam responder em até 1 dia
-
enhancement help wanted
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
ecosyste-ms/repos#1215 ·
Mantenedores costumam responder em até 1 dia
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
WikiEducationFoundation/WikiEduDashboard#7157 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
Mantenedores costumam responder em até 1 dia