microsoft / microsoft/azure-devops-python-api
Implement type hints on top of docstring `rtype`
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 684
- Forks
- 218
- Merge médio
- 8d 10h
- PRs com merge (30d)
- 1
Descrição
Hi,
The code is quite well documented, and uses docstring heavily. However, the "Python way" is to use type hints which are powerful and enable a good code completion.
For exaample, the client factory (get_git_client, get_build_client, ...) does not have type hints. Due to how it is written, python analyzers can not infer the returned types and this breaks autocompletion.
Could you please generate them them?
For example something like this:
def get_git_client(self) -> GitClient:
"""get_git_client.
Gets the 7.0 version of the GitClient
:rtype: :class:`<GitClient> <azure.devops.v7_0.git.git_client.GitClient>`
"""
return self._connection.get_client('azure.devops.v7_0.git.git_client.GitClient')
Thanks !
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
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 localizando os métodos factory de cliente mencionados na issue, incluindo get_git_client e get_build_client, e inspecione como as declarações rtype em suas docstrings correspondem aos clientes retornados. Determine o escopo das factories que precisam de anotações e verifique se os tipos de retorno resultantes restauram o autocompletar do analyzer; a issue não especifica arquivos ou testes.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- azure, python
- Domínio
- api
- Tipo de issue
- Funcionalidade
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 30/100