DiamondLightSource / DiamondLightSource/python-copier-template
Support linting docstrings
- Linguagem predominante
- Jinja
- Estrelas
- 25
- Forks
- 10
- Merge médio
- 4h 4min
- PRs com merge (30d)
- 6
Descrição
https://github.com/jsh9/pydoclint , https://github.com/akaihola/darglint2 and others lint docstrings to ensure they are congruent with the function/class/method that they are documenting. This could be a useful sanity check
Guia de contribuição
Direção de pesquisa
Nenhum arquivo ou teste é especificado. Comece inspecionando como o template configura o linting e as dependências do Python e, em seguida, compare pydoclint e darglint2 quanto à compatibilidade com essa configuração. O trabalho estará concluído quando uma ferramenta tiver sido escolhida, uma configuração integrada estiver implementada e for validado que as verificações de consistência de docstrings são executadas conforme esperado.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- tooling
- Tipo de issue
- Funcionalidade
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 38/100