How to put invisible comment in included file?
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 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 com ruby/ruby/doc/examples/files.rdoc e inspecione como o RDoc lida com as tentativas de usar :stopdoc:/:startdoc:, =begin/=end e formas de comentário no estilo HTML em arquivos .rdoc incluídos. Determine se uma sintaxe existente pode ocultar o aviso preservando os exemplos incluídos, ou qual deveria ser o comportamento de uma solução compatível; considera-se concluído quando o aviso está ausente da documentação gerada sem afetar os exemplos.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Over at ruby/ruby/doc/examples/files.rdoc, we have some code that supports examples in IO, File, and now Pathname.
File files.rdoc is included elsewhere.
I'd like to put into it an invisible warning (comment) about changing the file, since others depend upon it so closely.
I've tried :stopdoc:/:startdoc: and =begin/=end. Even an HTML-style comment like .
Is there some way to make an invisible comment in an included .rdoc file.
- Linguagem predominante
- Ruby
- Estrelas
- 928
- Forks
- 470
- Merge médio
- 1d 10h
- 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
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationTalvez já em andamento @OskarEichler assumiu há 57 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á 4 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á 16 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
Issues semelhantes
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
TheOdinProject/curriculum#31493 ·
Mantenedores costumam responder em até 1 dia
-
enhancement
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 62/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
rmosolgo/graphql-ruby#5843 ·
Mantenedores costumam responder em até 1 dia
-
Liens externes cassésAberta
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 66/100
betagouv/conseillers-entreprises#4770 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
seek4science/seek#2762 ·
Mantenedores costumam responder em até 5 dias