Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Docstrings need to embed parameters in backticks

Aberta
  • Algo errado?
#72 2 comentários 2 reações 0 responsáveis Ver no GitHub

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
30/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
julia
Domínio
documentation

Direção de pesquisa

Comece localizando o código que gera docstrings para parâmetros OpenAPI e reproduza a renderização markdown mostrada na issue. Verifique como os nomes de parâmetros que contêm sublinhados são emitidos; considera-se concluído quando esses nomes forem renderizados literalmente na documentação gerada, sem que o markdown os analise.

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

Descrição

stale

Otherwise, underscores get parsed as markdown, leading to:

Screenshot 2024-04-14 at 9 23 19 PM
Linguagem predominante
Julia
Estrelas
56
Forks
16
Merge médio
1d 51min
PRs com merge (30d)
12

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

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 JuliaComputing/OpenAPI.jl

Todas as issues de JuliaComputing/OpenAPI.jl

Issues semelhantes

Mais issues de Julia

Receba novas issues na sua caixa de entrada

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