[mkdocs] No types or annotations for parameters
Aberta
Ninguém assumiu esta issue ainda.
bug
P1
- Linguagem predominante
- Python
- Estrelas
- 18.8k
- Forks
- 2.8k
- Merge médio
- 16h 26min
- PRs com merge (30d)
- 21
Descrição
- Functions who include parameters in their docstring that are not explicitly written out in the function signature encounter a "Parameter '...' does not appear in the function signature" warning.
func(self, *args, **kwargs): all params in docstring raise warnings
- Any parameters who do not have a type annotation (except **kwargs and any parameter in the function signature) raises a "No types or annotations for parameters ['parameter_name']"
engine (deprecated) : strdoes not render correctly on markdown causing missing type annotation errorannotation_*doesn't render correctly, adding "\\" renders "annotation" and adding "\\*" renders "annotation"
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.
Direção de pesquisa
Comece reproduzindo os casos documentados de *args/**kwargs, engine obsoleto e annotation_* no caminho de renderização da documentação do MkDocs. Rastreie como os nomes dos parâmetros e as anotações são analisados e renderizados e, em seguida, verifique se os parâmetros válidos não produzem mais avisos e se seus tipos são exibidos corretamente em Markdown.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Bug
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100